Add samples HTML

ynput · Aug 13, 2024 · 7133f55 · 7133f55
1 parent f13f43d
commit 7133f55
Show file tree

Hide file tree

Showing 80 changed files with 70,943 additions and 0 deletions.
diff --git a/docs/build/html/.buildinfo b/docs/build/html/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 52a013cc4c81945ad370374607e3b142
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/build/html/.nojekyll b/docs/build/html/.nojekyll
diff --git a/docs/build/html/_images/AYON_blackG_dot.svg b/docs/build/html/_images/AYON_blackG_dot.svg
diff --git a/docs/build/html/_modules/ayon_api/_api.html b/docs/build/html/_modules/ayon_api/_api.html
diff --git a/docs/build/html/_modules/ayon_api/entity_hub.html b/docs/build/html/_modules/ayon_api/entity_hub.html
diff --git a/docs/build/html/_modules/ayon_api/events.html b/docs/build/html/_modules/ayon_api/events.html
@@ -0,0 +1,240 @@
+
+
+
+<!DOCTYPE html>
+<html class="writer-html5 " lang="en" >
+<head>
+	<meta charset="utf-8">
+
+	<meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+		<title>ayon_api.events &mdash; ayon-python-api 1.0.9-dev.1 documentation</title>
+
+
+
+	<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+	<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
+	<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
+	<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+		<link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+		<link rel="canonical" href="https://github.com/ynput/ayon-python-api_modules/ayon_api/events.html"/>
+
+
+
+	<!--[if lt IE 9]>
+		<script src="../../_static/js/html5shiv.min.js"></script>
+	<![endif]-->
+
+
+			<script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
+				<script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
+				<script src="../../_static/jquery.js"></script>
+				<script src="../../_static/underscore.js"></script>
+				<script src="../../_static/_sphinx_javascript_frameworks_compat.js"></script>
+				<script src="../../_static/doctools.js"></script>
+				<script src="../../_static/sphinx_highlight.js"></script>
+
+		<script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+		<link rel="index" title="Index" href="../../genindex.html" />
+		<link rel="search" title="Search" href="../../search.html" /> 
+</head>
+<body class="wy-body-for-nav">
+
+
+
+	<div class="wy-grid-for-nav">
+
+		<nav data-toggle="wy-nav-shift" class="wy-nav-side">
+			<div class="wy-side-scroll">
+				<div class="wy-side-nav-search">
+
+						<div class="brand">
+							<a href="../../index.html">
+
+								<img src="../../_static/AYON_blackG_dot.svg" class="logo" alt="Logo"/>
+
+							</a>
+						</div>
+
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+
+				</div>
+
+				<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+
+
+
+							<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../modules.html">ayon_api</a></li>
+</ul>
+
+
+
+				</div>
+
+			</div>
+		</nav>
+
+		<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+			<nav class="wy-nav-top" aria-label="top navigation">
+
+				<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+				<a href="../../index.html">
+
+						<img src="../../_static/AYON_blackG_dot.svg" class="logo" alt="Logo"/>
+
+				</a>
+
+			</nav>
+
+
+			<div class="wy-nav-content">
+
+				<div class="rst-content">
+
+					<div role="navigation" aria-label="breadcrumbs navigation">
+
+	<ul class="wy-breadcrumbs">
+
+
+				<li><a href="../../index.html">ayon-python-api</a> ⁄&nbsp;</li>
+
+					<li><a href="../index.html">Module code</a> ⁄&nbsp;</li>
+
+				<li><a href="">ayon_api.events</a></li>
+
+
+
+			<li class="wy-breadcrumbs-aside">
+
+				<a href="https://github.com/ynput/ayon-python-api" class="fa fa-github-alt"></a>
+
+			</li>
+
+	</ul>
+
+</div>
+					<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+					 <div itemprop="articleBody">
+
+  <h1>Source code for ayon_api.events</h1><div class="highlight"><pre>
+<span></span><span class="kn">import</span> <span class="nn">copy</span>
+
+
+<div class="viewcode-block" id="ServerEvent"><a class="viewcode-back" href="../../ayon_api.events.html#ayon_api.events.ServerEvent">[docs]</a><span class="k">class</span> <span class="nc">ServerEvent</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
+    <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span>
+        <span class="bp">self</span><span class="p">,</span>
+        <span class="n">topic</span><span class="p">,</span>
+        <span class="n">sender</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
+        <span class="n">event_hash</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
+        <span class="n">project_name</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
+        <span class="n">username</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
+        <span class="n">dependencies</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
+        <span class="n">description</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
+        <span class="n">summary</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
+        <span class="n">payload</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
+        <span class="n">finished</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
+        <span class="n">store</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
+    <span class="p">):</span>
+        <span class="k">if</span> <span class="n">dependencies</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
+            <span class="n">dependencies</span> <span class="o">=</span> <span class="p">[]</span>
+        <span class="k">if</span> <span class="n">payload</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
+            <span class="n">payload</span> <span class="o">=</span> <span class="p">{}</span>
+        <span class="k">if</span> <span class="n">summary</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
+            <span class="n">summary</span> <span class="o">=</span> <span class="p">{}</span>
+
+        <span class="bp">self</span><span class="o">.</span><span class="n">topic</span> <span class="o">=</span> <span class="n">topic</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">sender</span> <span class="o">=</span> <span class="n">sender</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">event_hash</span> <span class="o">=</span> <span class="n">event_hash</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">project_name</span> <span class="o">=</span> <span class="n">project_name</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">username</span> <span class="o">=</span> <span class="n">username</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">dependencies</span> <span class="o">=</span> <span class="n">dependencies</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">description</span> <span class="o">=</span> <span class="n">description</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">summary</span> <span class="o">=</span> <span class="n">summary</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">payload</span> <span class="o">=</span> <span class="n">payload</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">finished</span> <span class="o">=</span> <span class="n">finished</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">store</span> <span class="o">=</span> <span class="n">store</span>
+
+<div class="viewcode-block" id="ServerEvent.to_data"><a class="viewcode-back" href="../../ayon_api.events.html#ayon_api.events.ServerEvent.to_data">[docs]</a>    <span class="k">def</span> <span class="nf">to_data</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+        <span class="k">return</span> <span class="p">{</span>
+            <span class="s2">&quot;topic&quot;</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">topic</span><span class="p">,</span>
+            <span class="s2">&quot;sender&quot;</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">sender</span><span class="p">,</span>
+            <span class="s2">&quot;hash&quot;</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">event_hash</span><span class="p">,</span>
+            <span class="s2">&quot;project&quot;</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">project_name</span><span class="p">,</span>
+            <span class="s2">&quot;user&quot;</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">username</span><span class="p">,</span>
+            <span class="s2">&quot;dependencies&quot;</span><span class="p">:</span> <span class="n">copy</span><span class="o">.</span><span class="n">deepcopy</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">dependencies</span><span class="p">),</span>
+            <span class="s2">&quot;description&quot;</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">description</span><span class="p">,</span>
+            <span class="s2">&quot;description&quot;</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">description</span><span class="p">,</span>
+            <span class="s2">&quot;summary&quot;</span><span class="p">:</span> <span class="n">copy</span><span class="o">.</span><span class="n">deepcopy</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">summary</span><span class="p">),</span>
+            <span class="s2">&quot;payload&quot;</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">payload</span><span class="p">,</span>
+            <span class="s2">&quot;finished&quot;</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">finished</span><span class="p">,</span>
+            <span class="s2">&quot;store&quot;</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">store</span>
+        <span class="p">}</span></div></div>
+</pre></div>
+
+					 </div>
+
+					</div>
+					<footer>
+
+
+  <div role="contentinfo">
+    <p>
+
+        &copy; Copyright 2024, ynput.io <info@ynput.io>
+	  <br>
+
+
+
+      Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
+
+      <a href="https://github.com/revitron/revitron-sphinx-theme">theme</a>
+
+      provided by <a href="https://github.com/revitron">Revitron</a>.
+
+    </p>
+  </div> 
+
+</footer>
+
+				</div>
+			</div>
+
+		</section>
+
+	</div>
+
+
+	<script type="text/javascript">
+			jQuery(function () {
+					SphinxRtdTheme.Navigation.enable(true);
+			});
+	</script>
+
+
+
+
+
+
+
+</body>	
+</html>