Skip to content

Commit 2c38184

Browse files
Shotgun-RundeckShotgun-Rundeck
committed
Auto-updated documentation based on tag v5.9.0
1 parent b2d64e3 commit 2c38184

37 files changed

+443
-1009
lines changed

‎.buildinfo

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 564b8adb68be9c27092f166877d1d475
3+
config: c9c404a6accc9ad6e68775127381b822
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎.doctrees/environment.pickle

-98.1 KB
Binary file not shown.

‎.doctrees/external_config.doctree

0 Bytes
Binary file not shown.

‎.doctrees/index.doctree

0 Bytes
Binary file not shown.

‎.doctrees/settings.doctree

0 Bytes
Binary file not shown.

‎.doctrees/shotgun_data.doctree

0 Bytes
Binary file not shown.

‎.doctrees/shotgun_globals.doctree

0 Bytes
Binary file not shown.

‎.doctrees/shotgun_hierarchy_model.doctree

-18 KB
Binary file not shown.

‎.doctrees/shotgun_model.doctree

2 Bytes
Binary file not shown.

‎.doctrees/task_manager.doctree

0 Bytes
Binary file not shown.

‎_modules/external_config/config/config_base.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>external_config.config.config_base &mdash; tk-framework-shotgunutils v5.8.8 documentation</title>
8+
<title>external_config.config.config_base &mdash; tk-framework-shotgunutils v5.9.0 documentation</title>
99
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
1010
<link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
1111
<link rel="stylesheet" href="../../../_static/graphviz.css" type="text/css" />
@@ -84,7 +84,7 @@
8484
text-decoration: underline; }
8585
</style>
8686

87-
<b>tk-framework-shotgunutils</b> v5.8.8.<br>
87+
<b>tk-framework-shotgunutils</b> v5.9.0.<br>
8888

8989
This documentation is part of the Flow Production Tracking.
9090

‎_modules/external_config/external_command.html

+4-4
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>external_config.external_command &mdash; tk-framework-shotgunutils v5.8.8 documentation</title>
8+
<title>external_config.external_command &mdash; tk-framework-shotgunutils v5.9.0 documentation</title>
99
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
1010
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
1111
<link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />
@@ -84,7 +84,7 @@
8484
text-decoration: underline; }
8585
</style>
8686

87-
<b>tk-framework-shotgunutils</b> v5.8.8.<br>
87+
<b>tk-framework-shotgunutils</b> v5.9.0.<br>
8888

8989
This documentation is part of the Flow Production Tracking.
9090

@@ -181,7 +181,7 @@ <h1>Source code for external_config.external_command</h1><div class="highlight">
181181
<span class="sd"> :returns: True if the given data passes validation, False if not.</span>
182182
<span class="sd"> &quot;&quot;&quot;</span>
183183
<span class="c1"># We&#39;re only testing icon paths here just because that&#39;s the problem we</span>
184-
<span class="c1"># have right now in SG Create, but it&#39;s entirely possible (and maybe</span>
184+
<span class="c1"># have right now in Create, but it&#39;s entirely possible (and maybe</span>
185185
<span class="c1"># advisable) to check other things that are file/directory paths on</span>
186186
<span class="c1"># disk that might no longer exist.</span>
187187
<span class="n">icon_passes</span> <span class="o">=</span> <span class="kc">True</span>
@@ -633,7 +633,7 @@ <h1>Source code for external_config.external_command</h1><div class="highlight">
633633
<span class="c1"># some very bad behavior where it looked like PYTHONPATH was inherited from</span>
634634
<span class="c1"># this top-level environment rather than what is being set in external_runner</span>
635635
<span class="c1"># prior to launch. Also, the cwd is set a path we own so we avoid a situation</span>
636-
<span class="c1"># where the pwd contains conflicting DLLs, like SG Create&#39;s Qt DLLs that might</span>
636+
<span class="c1"># where the pwd contains conflicting DLLs, like Create&#39;s Qt DLLs that might</span>
637637
<span class="c1"># be loaded before another software&#39;s Qt DLLs because of the way DLLs are loaded...</span>
638638
<span class="c1"># (shorturl.at/nzDJW)</span>
639639
<span class="n">output</span> <span class="o">=</span> <span class="n">sgtk</span><span class="o">.</span><span class="n">util</span><span class="o">.</span><span class="n">process</span><span class="o">.</span><span class="n">subprocess_check_output</span><span class="p">(</span><span class="n">args</span><span class="p">,</span> <span class="n">cwd</span><span class="o">=</span><span class="n">subprocess_cwd</span><span class="p">)</span>

‎_modules/external_config/external_config_loader.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>external_config.external_config_loader &mdash; tk-framework-shotgunutils v5.8.8 documentation</title>
8+
<title>external_config.external_config_loader &mdash; tk-framework-shotgunutils v5.9.0 documentation</title>
99
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
1010
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
1111
<link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />
@@ -84,7 +84,7 @@
8484
text-decoration: underline; }
8585
</style>
8686

87-
<b>tk-framework-shotgunutils</b> v5.8.8.<br>
87+
<b>tk-framework-shotgunutils</b> v5.9.0.<br>
8888

8989
This documentation is part of the Flow Production Tracking.
9090

‎_modules/index.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>Overview: module code &mdash; tk-framework-shotgunutils v5.8.8 documentation</title>
8+
<title>Overview: module code &mdash; tk-framework-shotgunutils v5.9.0 documentation</title>
99
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
1010
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
1111
<link rel="stylesheet" href="../_static/graphviz.css" type="text/css" />
@@ -84,7 +84,7 @@
8484
text-decoration: underline; }
8585
</style>
8686

87-
<b>tk-framework-shotgunutils</b> v5.8.8.<br>
87+
<b>tk-framework-shotgunutils</b> v5.9.0.<br>
8888

8989
This documentation is part of the Flow Production Tracking.
9090

‎_modules/shotgun_data/shotgun_data_retriever.html

+6-6
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>shotgun_data.shotgun_data_retriever &mdash; tk-framework-shotgunutils v5.8.8 documentation</title>
8+
<title>shotgun_data.shotgun_data_retriever &mdash; tk-framework-shotgunutils v5.9.0 documentation</title>
99
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
1010
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
1111
<link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />
@@ -84,7 +84,7 @@
8484
text-decoration: underline; }
8585
</style>
8686

87-
<b>tk-framework-shotgunutils</b> v5.8.8.<br>
87+
<b>tk-framework-shotgunutils</b> v5.9.0.<br>
8888

8989
This documentation is part of the Flow Production Tracking.
9090

@@ -314,7 +314,7 @@ <h1>Source code for shotgun_data.shotgun_data_retriever</h1><div class="highligh
314314
<span class="n">bundle</span><span class="o">.</span><span class="n">ensure_folder_exists</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="n">path_to_cached_thumb</span><span class="p">))</span>
315315

316316
<span class="c1"># download using standard core method. This will ensure that</span>
317-
<span class="c1"># proxy and connection settings as set in the SG API are used</span>
317+
<span class="c1"># proxy and connection settings as set in the PTR API are used</span>
318318
<span class="k">try</span><span class="p">:</span>
319319
<span class="c1"># Ask sgtk.util.download_url() to append the file type extension</span>
320320
<span class="c1"># to the input path_to_cached_thumb to get the full path to the</span>
@@ -394,7 +394,7 @@ <h1>Source code for shotgun_data.shotgun_data_retriever</h1><div class="highligh
394394
<span class="n">bundle</span><span class="o">.</span><span class="n">ensure_folder_exists</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="n">path_to_cached_thumb</span><span class="p">))</span>
395395

396396
<span class="c1"># download using standard core method. This will ensure that</span>
397-
<span class="c1"># proxy and connection settings as set in the SG API are used.</span>
397+
<span class="c1"># proxy and connection settings as set in the PTR API are used.</span>
398398
<span class="c1"># Allow the core method to determine the file type extension</span>
399399
<span class="c1"># for the url about to be downloaded. Capture the full path to the</span>
400400
<span class="c1"># thumbnail file as returned by sgtk.util.download_url().</span>
@@ -988,7 +988,7 @@ <h1>Source code for shotgun_data.shotgun_data_retriever</h1><div class="highligh
988988
<span class="sd"> &quot;&quot;&quot;</span>
989989
<span class="k">try</span><span class="p">:</span>
990990
<span class="c1"># download using standard core method. This will ensure that</span>
991-
<span class="c1"># proxy and connection settings as set in the SG API are used</span>
991+
<span class="c1"># proxy and connection settings as set in the PTR API are used</span>
992992
<span class="k">try</span><span class="p">:</span>
993993
<span class="c1"># Ask sgtk.util.download_url() to append the file type extension</span>
994994
<span class="c1"># to the input file_path to get the full path to the cache file.</span>
@@ -1021,7 +1021,7 @@ <h1>Source code for shotgun_data.shotgun_data_retriever</h1><div class="highligh
10211021
<span class="p">)</span>
10221022
<span class="k">else</span><span class="p">:</span>
10231023
<span class="c1"># Again, download using standard core method. This will ensure that</span>
1024-
<span class="c1"># proxy and connection settings as set in the SG API are used.</span>
1024+
<span class="c1"># proxy and connection settings as set in the PTR API are used.</span>
10251025
<span class="n">url</span> <span class="o">=</span> <span class="n">sg_data</span><span class="p">[</span><span class="n">field</span><span class="p">]</span>
10261026
<span class="k">try</span><span class="p">:</span>
10271027
<span class="c1"># Ask sgtk.util.download_url() to append the file type extension</span>

‎_modules/shotgun_globals/date_time.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>shotgun_globals.date_time &mdash; tk-framework-shotgunutils v5.8.8 documentation</title>
8+
<title>shotgun_globals.date_time &mdash; tk-framework-shotgunutils v5.9.0 documentation</title>
99
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
1010
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
1111
<link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />
@@ -84,7 +84,7 @@
8484
text-decoration: underline; }
8585
</style>
8686

87-
<b>tk-framework-shotgunutils</b> v5.8.8.<br>
87+
<b>tk-framework-shotgunutils</b> v5.9.0.<br>
8888

8989
This documentation is part of the Flow Production Tracking.
9090

‎_modules/shotgun_globals/icon.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>shotgun_globals.icon &mdash; tk-framework-shotgunutils v5.8.8 documentation</title>
8+
<title>shotgun_globals.icon &mdash; tk-framework-shotgunutils v5.9.0 documentation</title>
99
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
1010
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
1111
<link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />
@@ -84,7 +84,7 @@
8484
text-decoration: underline; }
8585
</style>
8686

87-
<b>tk-framework-shotgunutils</b> v5.8.8.<br>
87+
<b>tk-framework-shotgunutils</b> v5.9.0.<br>
8888

8989
This documentation is part of the Flow Production Tracking.
9090

‎_modules/shotgun_model/shotgun_entity_model.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>shotgun_model.shotgun_entity_model &mdash; tk-framework-shotgunutils v5.8.8 documentation</title>
8+
<title>shotgun_model.shotgun_entity_model &mdash; tk-framework-shotgunutils v5.9.0 documentation</title>
99
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
1010
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
1111
<link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />
@@ -84,7 +84,7 @@
8484
text-decoration: underline; }
8585
</style>
8686

87-
<b>tk-framework-shotgunutils</b> v5.8.8.<br>
87+
<b>tk-framework-shotgunutils</b> v5.9.0.<br>
8888

8989
This documentation is part of the Flow Production Tracking.
9090

‎_modules/shotgun_model/shotgun_hierarchy_model.html

+4-4
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>shotgun_model.shotgun_hierarchy_model &mdash; tk-framework-shotgunutils v5.8.8 documentation</title>
8+
<title>shotgun_model.shotgun_hierarchy_model &mdash; tk-framework-shotgunutils v5.9.0 documentation</title>
99
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
1010
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
1111
<link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />
@@ -84,7 +84,7 @@
8484
text-decoration: underline; }
8585
</style>
8686

87-
<b>tk-framework-shotgunutils</b> v5.8.8.<br>
87+
<b>tk-framework-shotgunutils</b> v5.9.0.<br>
8888

8989
This documentation is part of the Flow Production Tracking.
9090

@@ -786,7 +786,7 @@ <h1>Source code for shotgun_model.shotgun_hierarchy_model</h1><div class="highli
786786
<span class="c1"># warn if the path is longer than the windows max path limitation</span>
787787
<span class="k">if</span> <span class="n">sgtk</span><span class="o">.</span><span class="n">util</span><span class="o">.</span><span class="n">is_windows</span><span class="p">()</span> <span class="ow">and</span> <span class="nb">len</span><span class="p">(</span><span class="n">data_cache_path</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">250</span><span class="p">:</span>
788788
<span class="bp">self</span><span class="o">.</span><span class="n">_log_warning</span><span class="p">(</span>
789-
<span class="s2">&quot;ShotGrid hierarchy data cache file path may be affected by &quot;</span>
789+
<span class="s2">&quot;Flow Production Tracking hierarchy data cache file path may be affected by &quot;</span>
790790
<span class="s2">&quot;windows MAX_PATH limitation.&quot;</span>
791791
<span class="p">)</span>
792792

@@ -816,7 +816,7 @@ <h1>Source code for shotgun_model.shotgun_hierarchy_model</h1><div class="highli
816816
<span class="p">):</span>
817817
<span class="k">return</span> <span class="p">(</span>
818818
<span class="kc">False</span><span class="p">,</span>
819-
<span class="s2">&quot;The version of SG being used does not support querying for the project &quot;</span>
819+
<span class="s2">&quot;The version of PTR being used does not support querying for the project &quot;</span>
820820
<span class="s2">&quot;hierarchy. v7.0.2 is required.&quot;</span><span class="p">,</span>
821821
<span class="p">)</span>
822822
<span class="k">elif</span> <span class="ow">not</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">sg_connection</span><span class="p">,</span> <span class="s2">&quot;nav_expand&quot;</span><span class="p">):</span>

‎_modules/shotgun_model/shotgun_model.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>shotgun_model.shotgun_model &mdash; tk-framework-shotgunutils v5.8.8 documentation</title>
8+
<title>shotgun_model.shotgun_model &mdash; tk-framework-shotgunutils v5.9.0 documentation</title>
99
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
1010
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
1111
<link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />
@@ -84,7 +84,7 @@
8484
text-decoration: underline; }
8585
</style>
8686

87-
<b>tk-framework-shotgunutils</b> v5.8.8.<br>
87+
<b>tk-framework-shotgunutils</b> v5.9.0.<br>
8888

8989
This documentation is part of the Flow Production Tracking.
9090

@@ -920,7 +920,7 @@ <h1>Source code for shotgun_model.shotgun_model</h1><div class="highlight"><pre>
920920

921921
<span class="k">if</span> <span class="n">sgtk</span><span class="o">.</span><span class="n">util</span><span class="o">.</span><span class="n">is_windows</span><span class="p">()</span> <span class="ow">and</span> <span class="nb">len</span><span class="p">(</span><span class="n">data_cache_path</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">250</span><span class="p">:</span>
922922
<span class="bp">self</span><span class="o">.</span><span class="n">_log_warning</span><span class="p">(</span>
923-
<span class="s2">&quot;ShotGrid model data cache file path may be affected by windows &quot;</span>
923+
<span class="s2">&quot;Flow Production Tracking model data cache file path may be affected by windows &quot;</span>
924924
<span class="s2">&quot;windows MAX_PATH limitation.&quot;</span>
925925
<span class="p">)</span>
926926

‎_modules/shotgun_model/simple_shotgun_hierarchy_model.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>shotgun_model.simple_shotgun_hierarchy_model &mdash; tk-framework-shotgunutils v5.8.8 documentation</title>
8+
<title>shotgun_model.simple_shotgun_hierarchy_model &mdash; tk-framework-shotgunutils v5.9.0 documentation</title>
99
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
1010
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
1111
<link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />
@@ -84,7 +84,7 @@
8484
text-decoration: underline; }
8585
</style>
8686

87-
<b>tk-framework-shotgunutils</b> v5.8.8.<br>
87+
<b>tk-framework-shotgunutils</b> v5.9.0.<br>
8888

8989
This documentation is part of the Flow Production Tracking.
9090

‎_modules/shotgun_model/simple_shotgun_model.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>shotgun_model.simple_shotgun_model &mdash; tk-framework-shotgunutils v5.8.8 documentation</title>
8+
<title>shotgun_model.simple_shotgun_model &mdash; tk-framework-shotgunutils v5.9.0 documentation</title>
99
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
1010
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
1111
<link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />
@@ -84,7 +84,7 @@
8484
text-decoration: underline; }
8585
</style>
8686

87-
<b>tk-framework-shotgunutils</b> v5.8.8.<br>
87+
<b>tk-framework-shotgunutils</b> v5.9.0.<br>
8888

8989
This documentation is part of the Flow Production Tracking.
9090

0 commit comments

Comments
 (0)