Skip to content

Commit 90e12d9

Browse files
Auto-updated documentation based on tag v5.10.2
1 parent f4269b7 commit 90e12d9

36 files changed

+367
-372
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: 13fb4f37a93b73c59f5ec1585c3cc13c
3+
config: b3f850d30fb81ca47ceff2f51224e08c
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

.doctrees/environment.pickle

305 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.
0 Bytes
Binary file not shown.

.doctrees/shotgun_model.doctree

0 Bytes
Binary file not shown.

.doctrees/task_manager.doctree

0 Bytes
Binary file not shown.

_modules/external_config/config/config_base.html

+32-32
Large diffs are not rendered by default.

_modules/external_config/external_command.html

+32-32
Large diffs are not rendered by default.

_modules/external_config/external_config_loader.html

+24-24
Large diffs are not rendered by default.

_modules/index.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>Overview: module code &mdash; tk-framework-shotgunutils v5.10.1 documentation</title>
8+
<title>Overview: module code &mdash; tk-framework-shotgunutils v5.10.2 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.10.1.<br>
87+
<b>tk-framework-shotgunutils</b> v5.10.2.<br>
8888

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

@@ -148,7 +148,7 @@ <h1>All modules for which code is available</h1>
148148
<hr/>
149149

150150
<div role="contentinfo">
151-
<p>&#169; Copyright 2024, Autodesk.</p>
151+
<p>&#169; Copyright 2025, Autodesk.</p>
152152
</div>
153153

154154

_modules/shotgun_data/shotgun_data_retriever.html

+63-63
Large diffs are not rendered by default.

_modules/shotgun_globals/date_time.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_globals.date_time &mdash; tk-framework-shotgunutils v5.10.1 documentation</title>
8+
<title>shotgun_globals.date_time &mdash; tk-framework-shotgunutils v5.10.2 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.10.1.<br>
87+
<b>tk-framework-shotgunutils</b> v5.10.2.<br>
8888

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

@@ -138,10 +138,10 @@ <h1>Source code for shotgun_globals.date_time</h1><div class="highlight"><pre>
138138
<span class="c1"># agreement to the Shotgun Pipeline Toolkit Source Code License. All rights</span>
139139
<span class="c1"># not expressly granted therein are reserved by Shotgun Software Inc.</span>
140140

141-
<span class="kn">import</span> <span class="nn">datetime</span>
141+
<span class="kn">import</span><span class="w"> </span><span class="nn">datetime</span>
142142

143143

144-
<div class="viewcode-block" id="create_human_readable_date"><a class="viewcode-back" href="../../shotgun_globals.html#shotgun_globals.create_human_readable_date">[docs]</a><span class="k">def</span> <span class="nf">create_human_readable_date</span><span class="p">(</span><span class="n">dt</span><span class="p">):</span>
144+
<div class="viewcode-block" id="create_human_readable_date"><a class="viewcode-back" href="../../shotgun_globals.html#shotgun_globals.create_human_readable_date">[docs]</a><span class="k">def</span><span class="w"> </span><span class="nf">create_human_readable_date</span><span class="p">(</span><span class="n">dt</span><span class="p">):</span>
145145
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
146146
<span class="sd"> Return the date represented by the argument as a string, displaying recent</span>
147147
<span class="sd"> dates as &quot;Yesterday&quot;, &quot;Today&quot;, or &quot;Tomorrow&quot;.</span>
@@ -170,7 +170,7 @@ <h1>Source code for shotgun_globals.date_time</h1><div class="highlight"><pre>
170170
<span class="k">return</span> <span class="n">date_str</span></div>
171171

172172

173-
<span class="k">def</span> <span class="nf">create_human_readable_timestamp</span><span class="p">(</span><span class="n">dt</span><span class="p">,</span> <span class="n">postfix</span><span class="o">=</span><span class="s2">&quot;&quot;</span><span class="p">):</span>
173+
<span class="k">def</span><span class="w"> </span><span class="nf">create_human_readable_timestamp</span><span class="p">(</span><span class="n">dt</span><span class="p">,</span> <span class="n">postfix</span><span class="o">=</span><span class="s2">&quot;&quot;</span><span class="p">):</span>
174174
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
175175
<span class="sd"> Return the time represented by the argument as a string where the date portion is</span>
176176
<span class="sd"> displayed as &quot;Yesterday&quot;, &quot;Today&quot;, or &quot;Tomorrow&quot; if appropriate.</span>
@@ -205,7 +205,7 @@ <h1>Source code for shotgun_globals.date_time</h1><div class="highlight"><pre>
205205
<hr/>
206206

207207
<div role="contentinfo">
208-
<p>&#169; Copyright 2024, Autodesk.</p>
208+
<p>&#169; Copyright 2025, Autodesk.</p>
209209
</div>
210210

211211

_modules/shotgun_globals/icon.html

+7-7
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.10.1 documentation</title>
8+
<title>shotgun_globals.icon &mdash; tk-framework-shotgunutils v5.10.2 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.10.1.<br>
87+
<b>tk-framework-shotgunutils</b> v5.10.2.<br>
8888

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

@@ -138,8 +138,8 @@ <h1>Source code for shotgun_globals.icon</h1><div class="highlight"><pre>
138138
<span class="c1"># agreement to the Shotgun Pipeline Toolkit Source Code License. All rights</span>
139139
<span class="c1"># not expressly granted therein are reserved by Shotgun Software Inc.</span>
140140

141-
<span class="kn">from</span> <span class="nn">sgtk.platform.qt</span> <span class="kn">import</span> <span class="n">QtCore</span><span class="p">,</span> <span class="n">QtGui</span>
142-
<span class="kn">from</span> <span class="nn">.ui</span> <span class="kn">import</span> <span class="n">resources_rc</span>
141+
<span class="kn">from</span><span class="w"> </span><span class="nn">sgtk.platform.qt</span><span class="w"> </span><span class="kn">import</span> <span class="n">QtCore</span><span class="p">,</span> <span class="n">QtGui</span>
142+
<span class="kn">from</span><span class="w"> </span><span class="nn">.ui</span><span class="w"> </span><span class="kn">import</span> <span class="n">resources_rc</span>
143143

144144
<span class="c1"># list of all entity types for which an icon exists</span>
145145
<span class="n">_entity_types_with_icons</span> <span class="o">=</span> <span class="p">[</span>
@@ -164,7 +164,7 @@ <h1>Source code for shotgun_globals.icon</h1><div class="highlight"><pre>
164164
<span class="n">_cached_entity_icons</span> <span class="o">=</span> <span class="p">{}</span>
165165

166166

167-
<div class="viewcode-block" id="get_entity_type_icon_url"><a class="viewcode-back" href="../../shotgun_globals.html#shotgun_globals.get_entity_type_icon_url">[docs]</a><span class="k">def</span> <span class="nf">get_entity_type_icon_url</span><span class="p">(</span><span class="n">entity_type</span><span class="p">):</span>
167+
<div class="viewcode-block" id="get_entity_type_icon_url"><a class="viewcode-back" href="../../shotgun_globals.html#shotgun_globals.get_entity_type_icon_url">[docs]</a><span class="k">def</span><span class="w"> </span><span class="nf">get_entity_type_icon_url</span><span class="p">(</span><span class="n">entity_type</span><span class="p">):</span>
168168
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
169169
<span class="sd"> Retrieve the icon resource path for the specified entity type if available.</span>
170170

@@ -180,7 +180,7 @@ <h1>Source code for shotgun_globals.icon</h1><div class="highlight"><pre>
180180
<span class="k">return</span> <span class="kc">None</span></div>
181181

182182

183-
<div class="viewcode-block" id="get_entity_type_icon"><a class="viewcode-back" href="../../shotgun_globals.html#shotgun_globals.get_entity_type_icon">[docs]</a><span class="k">def</span> <span class="nf">get_entity_type_icon</span><span class="p">(</span><span class="n">entity_type</span><span class="p">):</span>
183+
<div class="viewcode-block" id="get_entity_type_icon"><a class="viewcode-back" href="../../shotgun_globals.html#shotgun_globals.get_entity_type_icon">[docs]</a><span class="k">def</span><span class="w"> </span><span class="nf">get_entity_type_icon</span><span class="p">(</span><span class="n">entity_type</span><span class="p">):</span>
184184
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
185185
<span class="sd"> Retrieve the icon for the specified entity type if available.</span>
186186

@@ -210,7 +210,7 @@ <h1>Source code for shotgun_globals.icon</h1><div class="highlight"><pre>
210210
<hr/>
211211

212212
<div role="contentinfo">
213-
<p>&#169; Copyright 2024, Autodesk.</p>
213+
<p>&#169; Copyright 2025, Autodesk.</p>
214214
</div>
215215

216216

0 commit comments

Comments
 (0)