Auto-updated documentation based on tag v0.20.24

shotgunsoftware · Sep 6, 2023 · 59a3347 · 59a3347
1 parent ab1fe8b
commit 59a3347
Show file tree

Hide file tree

Showing 89 changed files with 172 additions and 158 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -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: c3189b2c616455471a70b5f9f0637057
+config: 1d9888750a14fa4e8e4cda6f2bf35e64
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/.doctrees/authentication.doctree b/.doctrees/authentication.doctree
diff --git a/.doctrees/core.doctree b/.doctrees/core.doctree
diff --git a/.doctrees/descriptor.doctree b/.doctrees/descriptor.doctree
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/.doctrees/environment_variables.doctree b/.doctrees/environment_variables.doctree
diff --git a/.doctrees/index.doctree b/.doctrees/index.doctree
diff --git a/.doctrees/initializing.doctree b/.doctrees/initializing.doctree
diff --git a/.doctrees/overview.doctree b/.doctrees/overview.doctree
diff --git a/.doctrees/platform.doctree b/.doctrees/platform.doctree
diff --git a/.doctrees/utils.doctree b/.doctrees/utils.doctree
diff --git a/_modules/before_register_publish.html b/_modules/before_register_publish.html
@@ -10,7 +10,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>before_register_publish &mdash; tk-core v0.20.22 documentation</title>
+  <title>before_register_publish &mdash; tk-core v0.20.24 documentation</title>
 
 
 
@@ -123,7 +123,7 @@
                              text-decoration: underline; }
     </style>
 
-    <b>tk-core</b> v0.20.22.<br>
+    <b>tk-core</b> v0.20.24.<br>
 
         This documentation is part of the ShotGrid Pipeline Toolkit.
 

diff --git a/_modules/bootstrap.html b/_modules/bootstrap.html
@@ -10,7 +10,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>bootstrap &mdash; tk-core v0.20.22 documentation</title>
+  <title>bootstrap &mdash; tk-core v0.20.24 documentation</title>
 
 
 
@@ -123,7 +123,7 @@
                              text-decoration: underline; }
     </style>
 
-    <b>tk-core</b> v0.20.22.<br>
+    <b>tk-core</b> v0.20.24.<br>
 
         This documentation is part of the ShotGrid Pipeline Toolkit.
 

diff --git a/_modules/bundle_init.html b/_modules/bundle_init.html
@@ -10,7 +10,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>bundle_init &mdash; tk-core v0.20.22 documentation</title>
+  <title>bundle_init &mdash; tk-core v0.20.24 documentation</title>
 
 
 
@@ -123,7 +123,7 @@
                              text-decoration: underline; }
     </style>
 
-    <b>tk-core</b> v0.20.22.<br>
+    <b>tk-core</b> v0.20.24.<br>
 
         This documentation is part of the ShotGrid Pipeline Toolkit.
 

diff --git a/_modules/cache_location.html b/_modules/cache_location.html
@@ -10,7 +10,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>cache_location &mdash; tk-core v0.20.22 documentation</title>
+  <title>cache_location &mdash; tk-core v0.20.24 documentation</title>
 
 
 
@@ -123,7 +123,7 @@
                              text-decoration: underline; }
     </style>
 
-    <b>tk-core</b> v0.20.22.<br>
+    <b>tk-core</b> v0.20.24.<br>
 
         This documentation is part of the ShotGrid Pipeline Toolkit.
 
@@ -253,7 +253,7 @@ <h1>Source code for cache_location</h1><div class="highlight"><pre>
 <span class="sd">        :rtype: str</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="c1"># backwards compatibility with custom hooks created before 0.18</span>
-        <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">&quot;path_cache&quot;</span><span class="p">)</span> <span class="ow">and</span> <span class="n">callable</span><span class="p">(</span><span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">&quot;path_cache&quot;</span><span class="p">)):</span>
+        <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">&quot;path_cache&quot;</span><span class="p">)</span> <span class="ow">and</span> <span class="nb">callable</span><span class="p">(</span><span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">&quot;path_cache&quot;</span><span class="p">)):</span>
             <span class="c1"># there is a custom version of the legacy hook path_cache</span>
             <span class="n">log</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span>
                 <span class="s2">&quot;Detected old core cache hook implementation. &quot;</span>
@@ -354,7 +354,7 @@ <h1>Source code for cache_location</h1><div class="highlight"><pre>
 <span class="sd">        :rtype: str</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="c1"># backwards compatibility with custom hooks created before 0.18</span>
-        <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">&quot;bundle_cache&quot;</span><span class="p">)</span> <span class="ow">and</span> <span class="n">callable</span><span class="p">(</span><span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">&quot;bundle_cache&quot;</span><span class="p">)):</span>
+        <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">&quot;bundle_cache&quot;</span><span class="p">)</span> <span class="ow">and</span> <span class="nb">callable</span><span class="p">(</span><span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">&quot;bundle_cache&quot;</span><span class="p">)):</span>
             <span class="c1"># there is a custom version of the legacy hook path_cache</span>
             <span class="n">log</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span>
                 <span class="s2">&quot;Detected old core cache hook implementation. &quot;</span>

diff --git a/_modules/context_change.html b/_modules/context_change.html
@@ -10,7 +10,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>context_change &mdash; tk-core v0.20.22 documentation</title>
+  <title>context_change &mdash; tk-core v0.20.24 documentation</title>
 
 
 
@@ -123,7 +123,7 @@
                              text-decoration: underline; }
     </style>
 
-    <b>tk-core</b> v0.20.22.<br>
+    <b>tk-core</b> v0.20.24.<br>
 
         This documentation is part of the ShotGrid Pipeline Toolkit.
 

diff --git a/_modules/engine_init.html b/_modules/engine_init.html
@@ -10,7 +10,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>engine_init &mdash; tk-core v0.20.22 documentation</title>
+  <title>engine_init &mdash; tk-core v0.20.24 documentation</title>
 
 
 
@@ -123,7 +123,7 @@
                              text-decoration: underline; }
     </style>
 
-    <b>tk-core</b> v0.20.22.<br>
+    <b>tk-core</b> v0.20.24.<br>
 
         This documentation is part of the ShotGrid Pipeline Toolkit.
 

diff --git a/_modules/ensure_folder_exists.html b/_modules/ensure_folder_exists.html
@@ -10,7 +10,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>ensure_folder_exists &mdash; tk-core v0.20.22 documentation</title>
+  <title>ensure_folder_exists &mdash; tk-core v0.20.24 documentation</title>
 
 
 
@@ -123,7 +123,7 @@
                              text-decoration: underline; }
     </style>
 
-    <b>tk-core</b> v0.20.22.<br>
+    <b>tk-core</b> v0.20.24.<br>
 
         This documentation is part of the ShotGrid Pipeline Toolkit.
 

diff --git a/_modules/example_template_hook.html b/_modules/example_template_hook.html
@@ -10,7 +10,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>example_template_hook &mdash; tk-core v0.20.22 documentation</title>
+  <title>example_template_hook &mdash; tk-core v0.20.24 documentation</title>
 
 
 
@@ -123,7 +123,7 @@
                              text-decoration: underline; }
     </style>
 
-    <b>tk-core</b> v0.20.22.<br>
+    <b>tk-core</b> v0.20.24.<br>
 
         This documentation is part of the ShotGrid Pipeline Toolkit.
 

diff --git a/_modules/get_current_login.html b/_modules/get_current_login.html
@@ -10,7 +10,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>get_current_login &mdash; tk-core v0.20.22 documentation</title>
+  <title>get_current_login &mdash; tk-core v0.20.24 documentation</title>
 
 
 
@@ -123,7 +123,7 @@
                              text-decoration: underline; }
     </style>
 
-    <b>tk-core</b> v0.20.22.<br>
+    <b>tk-core</b> v0.20.24.<br>
 
         This documentation is part of the ShotGrid Pipeline Toolkit.
 

diff --git a/_modules/index.html b/_modules/index.html
@@ -10,7 +10,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Overview: module code &mdash; tk-core v0.20.22 documentation</title>
+  <title>Overview: module code &mdash; tk-core v0.20.24 documentation</title>
 
 
 
@@ -123,7 +123,7 @@
                              text-decoration: underline; }
     </style>
 
-    <b>tk-core</b> v0.20.22.<br>
+    <b>tk-core</b> v0.20.24.<br>
 
         This documentation is part of the ShotGrid Pipeline Toolkit.
 

diff --git a/_modules/log_metrics.html b/_modules/log_metrics.html
@@ -10,7 +10,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>log_metrics &mdash; tk-core v0.20.22 documentation</title>
+  <title>log_metrics &mdash; tk-core v0.20.24 documentation</title>
 
 
 
@@ -123,7 +123,7 @@
                              text-decoration: underline; }
     </style>
 
-    <b>tk-core</b> v0.20.22.<br>
+    <b>tk-core</b> v0.20.24.<br>
 
         This documentation is part of the ShotGrid Pipeline Toolkit.
 

diff --git a/_modules/pick_environment.html b/_modules/pick_environment.html
@@ -10,7 +10,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>pick_environment &mdash; tk-core v0.20.22 documentation</title>
+  <title>pick_environment &mdash; tk-core v0.20.24 documentation</title>
 
 
 
@@ -123,7 +123,7 @@
                              text-decoration: underline; }
     </style>
 
-    <b>tk-core</b> v0.20.22.<br>
+    <b>tk-core</b> v0.20.24.<br>
 
         This documentation is part of the ShotGrid Pipeline Toolkit.
 

diff --git a/_modules/pipeline_configuration_init.html b/_modules/pipeline_configuration_init.html
@@ -10,7 +10,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>pipeline_configuration_init &mdash; tk-core v0.20.22 documentation</title>
+  <title>pipeline_configuration_init &mdash; tk-core v0.20.24 documentation</title>
 
 
 
@@ -123,7 +123,7 @@
                              text-decoration: underline; }
     </style>
 
-    <b>tk-core</b> v0.20.22.<br>
+    <b>tk-core</b> v0.20.24.<br>
 
         This documentation is part of the ShotGrid Pipeline Toolkit.
 

diff --git a/_modules/process_folder_creation.html b/_modules/process_folder_creation.html
@@ -10,7 +10,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>process_folder_creation &mdash; tk-core v0.20.22 documentation</title>
+  <title>process_folder_creation &mdash; tk-core v0.20.24 documentation</title>
 
 
 
@@ -123,7 +123,7 @@
                              text-decoration: underline; }
     </style>
 
-    <b>tk-core</b> v0.20.22.<br>
+    <b>tk-core</b> v0.20.24.<br>
 
         This documentation is part of the ShotGrid Pipeline Toolkit.
 

diff --git a/_modules/process_folder_name.html b/_modules/process_folder_name.html
@@ -10,7 +10,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>process_folder_name &mdash; tk-core v0.20.22 documentation</title>
+  <title>process_folder_name &mdash; tk-core v0.20.24 documentation</title>
 
 
 
@@ -123,7 +123,7 @@
                              text-decoration: underline; }
     </style>
 
-    <b>tk-core</b> v0.20.22.<br>
+    <b>tk-core</b> v0.20.24.<br>
 
         This documentation is part of the ShotGrid Pipeline Toolkit.
 

diff --git a/_modules/resolve_publish.html b/_modules/resolve_publish.html
@@ -10,7 +10,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>resolve_publish &mdash; tk-core v0.20.22 documentation</title>
+  <title>resolve_publish &mdash; tk-core v0.20.24 documentation</title>
 
 
 
@@ -123,7 +123,7 @@
                              text-decoration: underline; }
     </style>
 
-    <b>tk-core</b> v0.20.22.<br>
+    <b>tk-core</b> v0.20.24.<br>
 
         This documentation is part of the ShotGrid Pipeline Toolkit.
 

diff --git a/_modules/tank/api.html b/_modules/tank/api.html
@@ -10,7 +10,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>tank.api &mdash; tk-core v0.20.22 documentation</title>
+  <title>tank.api &mdash; tk-core v0.20.24 documentation</title>
 
 
 
@@ -123,7 +123,7 @@
                              text-decoration: underline; }
     </style>
 
-    <b>tk-core</b> v0.20.22.<br>
+    <b>tk-core</b> v0.20.24.<br>
 
         This documentation is part of the ShotGrid Pipeline Toolkit.
 

diff --git a/_modules/tank/authentication/defaults_manager.html b/_modules/tank/authentication/defaults_manager.html
@@ -10,7 +10,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>tank.authentication.defaults_manager &mdash; tk-core v0.20.22 documentation</title>
+  <title>tank.authentication.defaults_manager &mdash; tk-core v0.20.24 documentation</title>
 
 
 
@@ -123,7 +123,7 @@
                              text-decoration: underline; }
     </style>
 
-    <b>tk-core</b> v0.20.22.<br>
+    <b>tk-core</b> v0.20.24.<br>
 
         This documentation is part of the ShotGrid Pipeline Toolkit.
 

diff --git a/_modules/tank/authentication/errors.html b/_modules/tank/authentication/errors.html
@@ -10,7 +10,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>tank.authentication.errors &mdash; tk-core v0.20.22 documentation</title>
+  <title>tank.authentication.errors &mdash; tk-core v0.20.24 documentation</title>
 
 
 
@@ -123,7 +123,7 @@
                              text-decoration: underline; }
     </style>
 
-    <b>tk-core</b> v0.20.22.<br>
+    <b>tk-core</b> v0.20.24.<br>
 
         This documentation is part of the ShotGrid Pipeline Toolkit.
 

diff --git a/_modules/tank/authentication/shotgun_authenticator.html b/_modules/tank/authentication/shotgun_authenticator.html
@@ -10,7 +10,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>tank.authentication.shotgun_authenticator &mdash; tk-core v0.20.22 documentation</title>
+  <title>tank.authentication.shotgun_authenticator &mdash; tk-core v0.20.24 documentation</title>
 
 
 
@@ -123,7 +123,7 @@
                              text-decoration: underline; }
     </style>
 
-    <b>tk-core</b> v0.20.22.<br>
+    <b>tk-core</b> v0.20.24.<br>
 
         This documentation is part of the ShotGrid Pipeline Toolkit.