Skip to content

Commit

Permalink
Auto-updated documentation based on tag v0.4.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@Shotgun-Rundeck
Shotgun-Rundeck committed Apr 25, 2024
1 parent 4b53a17 commit 6b3c9f1
Show file tree
Hide file tree
Showing 31 changed files with 235 additions and 101 deletions.
2 changes: 1 addition & 1 deletion .buildinfo
View file
Original file line number Diff line number Diff line change
@@ -1,4 +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: 5e4c5ff33e5c38fe1722bf25492cd946
config: cf4a970e45580340301533b2997e1a1f
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified .doctrees/api.doctree
View file
Binary file not shown.
Binary file modified .doctrees/engine-specific-notes.doctree
View file
Binary file not shown.
Binary file modified .doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified .doctrees/hooks.doctree
View file
Binary file not shown.
Binary file modified .doctrees/index.doctree
View file
Binary file not shown.
Binary file modified .doctrees/tk-alias.doctree
View file
Binary file not shown.
Binary file modified .doctrees/tk-houdini.doctree
View file
Binary file not shown.
Binary file modified .doctrees/tk-mari.doctree
View file
Binary file not shown.
Binary file modified .doctrees/tk-maya.doctree
View file
Binary file not shown.
Binary file modified .doctrees/tk-nuke.doctree
View file
Binary file not shown.
Binary file modified .doctrees/tk-vred.doctree
View file
Binary file not shown.
4 changes: 2 additions & 2 deletions _modules/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Overview: module code &mdash; tk-multi-breakdown2 v0.3.0 documentation</title>
<title>Overview: module code &mdash; tk-multi-breakdown2 v0.4.0 documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/graphviz.css" type="text/css" />
Expand Down Expand Up @@ -80,7 +80,7 @@
text-decoration: underline; }
</style>

<b>tk-multi-breakdown2</b> v0.3.0.<br>
<b>tk-multi-breakdown2</b> v0.4.0.<br>

This documentation is part of the Flow Production Tracking.

Expand Down
29 changes: 25 additions & 4 deletions _modules/tk_multi_breakdown2/api/item.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>tk_multi_breakdown2.api.item &mdash; tk-multi-breakdown2 v0.3.0 documentation</title>
<title>tk_multi_breakdown2.api.item &mdash; tk-multi-breakdown2 v0.4.0 documentation</title>
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/graphviz.css" type="text/css" />
Expand Down Expand Up @@ -80,7 +80,7 @@
text-decoration: underline; }
</style>

<b>tk-multi-breakdown2</b> v0.3.0.<br>
<b>tk-multi-breakdown2</b> v0.4.0.<br>

This documentation is part of the Flow Production Tracking.

Expand Down Expand Up @@ -141,7 +141,16 @@ <h1>Source code for tk_multi_breakdown2.api.item</h1><div class="highlight"><pre
<span class="sd"> but will contain details about the latest available version of the file.</span>
<span class="sd"> &quot;&quot;&quot;</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">node_name</span><span class="p">,</span> <span class="n">node_type</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">sg_data</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">extra_data</span><span class="o">=</span><span class="kc">None</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">node_name</span><span class="p">,</span>
<span class="n">node_type</span><span class="p">,</span>
<span class="n">path</span><span class="p">,</span>
<span class="n">sg_data</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">extra_data</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">locked</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
<span class="n">loaded</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
<span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Class constructor.</span>

Expand All @@ -150,15 +159,18 @@ <h1>Source code for tk_multi_breakdown2.api.item</h1><div class="highlight"><pre
<span class="sd"> :param path: Path on disk of this file</span>
<span class="sd"> :param sg_data: Dictionary of Flow Production Tracking data representing this file in the database</span>
<span class="sd"> :param extra_data: Dictionary containing additional information about this file</span>
<span class="sd"> :param locked: True if the file item is locked, else False.</span>
<span class="sd"> :param loaded: True if the file item is loaded, else False.</span>
<span class="sd"> &quot;&quot;&quot;</span>

<span class="bp">self</span><span class="o">.</span><span class="n">_node_name</span> <span class="o">=</span> <span class="n">node_name</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_node_type</span> <span class="o">=</span> <span class="n">node_type</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_path</span> <span class="o">=</span> <span class="n">path</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_sg_data</span> <span class="o">=</span> <span class="n">sg_data</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_extra_data</span> <span class="o">=</span> <span class="n">extra_data</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_locked</span> <span class="o">=</span> <span class="n">locked</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_loaded</span> <span class="o">=</span> <span class="n">loaded</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_latest_published_file</span> <span class="o">=</span> <span class="kc">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_locked</span> <span class="o">=</span> <span class="kc">False</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_thumbnail_path</span> <span class="o">=</span> <span class="kc">None</span>

<span class="k">def</span> <span class="fm">__hash__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
Expand Down Expand Up @@ -230,6 +242,15 @@ <h1>Source code for tk_multi_breakdown2.api.item</h1><div class="highlight"><pre
<span class="k">def</span> <span class="nf">locked</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_locked</span> <span class="o">=</span> <span class="n">value</span>

<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">loaded</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Get whether or not this file item is loaded.&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_loaded</span>

<span class="nd">@loaded</span><span class="o">.</span><span class="n">setter</span>
<span class="k">def</span> <span class="nf">loaded</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_loaded</span> <span class="o">=</span> <span class="n">value</span>

<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">latest_published_file</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Get the latest published file for this file item.&quot;&quot;&quot;</span>
Expand Down
Loading

0 comments on commit 6b3c9f1

Please sign in to comment.