Auto-updated documentation based on tag v0.20.31

shotgunsoftware · Jan 29, 2024 · d44eae0 · d44eae0
1 parent a82ffcd
commit d44eae0
Show file tree

Hide file tree

Showing 90 changed files with 291 additions and 251 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: 0a4d4bda147ffbd926442da275c13419
+config: 6d5205c04b49e80679e47e55cdd96c38
 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
@@ -5,7 +5,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>before_register_publish &mdash; tk-core v0.20.28 documentation</title>
+  <title>before_register_publish &mdash; tk-core v0.20.31 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" />
@@ -85,7 +85,7 @@
                              text-decoration: underline; }
     </style>
 
-    <b>tk-core</b> v0.20.28.<br>
+    <b>tk-core</b> v0.20.31.<br>
 
         This documentation is part of the ShotGrid Pipeline Toolkit.
 
@@ -173,7 +173,7 @@ <h1>Source code for before_register_publish</h1><div class="highlight"><pre>
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023, Autodesk.</p>
+    <p>&#169; Copyright 2024, Autodesk.</p>
   </div>
 
 

diff --git a/_modules/bootstrap.html b/_modules/bootstrap.html
@@ -5,7 +5,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>bootstrap &mdash; tk-core v0.20.28 documentation</title>
+  <title>bootstrap &mdash; tk-core v0.20.31 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" />
@@ -85,7 +85,7 @@
                              text-decoration: underline; }
     </style>
 
-    <b>tk-core</b> v0.20.28.<br>
+    <b>tk-core</b> v0.20.31.<br>
 
         This documentation is part of the ShotGrid Pipeline Toolkit.
 
@@ -221,7 +221,7 @@ <h1>Source code for bootstrap</h1><div class="highlight"><pre>
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023, Autodesk.</p>
+    <p>&#169; Copyright 2024, Autodesk.</p>
   </div>
 
 

diff --git a/_modules/bundle_init.html b/_modules/bundle_init.html
@@ -5,7 +5,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>bundle_init &mdash; tk-core v0.20.28 documentation</title>
+  <title>bundle_init &mdash; tk-core v0.20.31 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" />
@@ -85,7 +85,7 @@
                              text-decoration: underline; }
     </style>
 
-    <b>tk-core</b> v0.20.28.<br>
+    <b>tk-core</b> v0.20.31.<br>
 
         This documentation is part of the ShotGrid Pipeline Toolkit.
 
@@ -167,7 +167,7 @@ <h1>Source code for bundle_init</h1><div class="highlight"><pre>
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023, Autodesk.</p>
+    <p>&#169; Copyright 2024, Autodesk.</p>
   </div>
 
 

diff --git a/_modules/cache_location.html b/_modules/cache_location.html
@@ -5,7 +5,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>cache_location &mdash; tk-core v0.20.28 documentation</title>
+  <title>cache_location &mdash; tk-core v0.20.31 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" />
@@ -85,7 +85,7 @@
                              text-decoration: underline; }
     </style>
 
-    <b>tk-core</b> v0.20.28.<br>
+    <b>tk-core</b> v0.20.31.<br>
 
         This documentation is part of the ShotGrid Pipeline Toolkit.
 
@@ -356,7 +356,7 @@ <h1>Source code for cache_location</h1><div class="highlight"><pre>
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023, Autodesk.</p>
+    <p>&#169; Copyright 2024, Autodesk.</p>
   </div>
 
 

diff --git a/_modules/context_change.html b/_modules/context_change.html
@@ -5,7 +5,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>context_change &mdash; tk-core v0.20.28 documentation</title>
+  <title>context_change &mdash; tk-core v0.20.31 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" />
@@ -85,7 +85,7 @@
                              text-decoration: underline; }
     </style>
 
-    <b>tk-core</b> v0.20.28.<br>
+    <b>tk-core</b> v0.20.31.<br>
 
         This documentation is part of the ShotGrid Pipeline Toolkit.
 
@@ -203,7 +203,7 @@ <h1>Source code for context_change</h1><div class="highlight"><pre>
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023, Autodesk.</p>
+    <p>&#169; Copyright 2024, Autodesk.</p>
   </div>
 
 

diff --git a/_modules/default_storage_root.html b/_modules/default_storage_root.html
@@ -5,7 +5,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>default_storage_root &mdash; tk-core v0.20.28 documentation</title>
+  <title>default_storage_root &mdash; tk-core v0.20.31 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" />
@@ -85,7 +85,7 @@
                              text-decoration: underline; }
     </style>
 
-    <b>tk-core</b> v0.20.28.<br>
+    <b>tk-core</b> v0.20.31.<br>
 
         This documentation is part of the ShotGrid Pipeline Toolkit.
 
@@ -176,7 +176,7 @@ <h1>Source code for default_storage_root</h1><div class="highlight"><pre>
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023, Autodesk.</p>
+    <p>&#169; Copyright 2024, Autodesk.</p>
   </div>
 
 

diff --git a/_modules/engine_init.html b/_modules/engine_init.html
@@ -5,7 +5,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>engine_init &mdash; tk-core v0.20.28 documentation</title>
+  <title>engine_init &mdash; tk-core v0.20.31 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" />
@@ -85,7 +85,7 @@
                              text-decoration: underline; }
     </style>
 
-    <b>tk-core</b> v0.20.28.<br>
+    <b>tk-core</b> v0.20.31.<br>
 
         This documentation is part of the ShotGrid Pipeline Toolkit.
 
@@ -169,7 +169,7 @@ <h1>Source code for engine_init</h1><div class="highlight"><pre>
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023, Autodesk.</p>
+    <p>&#169; Copyright 2024, Autodesk.</p>
   </div>
 
 

diff --git a/_modules/ensure_folder_exists.html b/_modules/ensure_folder_exists.html
@@ -5,7 +5,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>ensure_folder_exists &mdash; tk-core v0.20.28 documentation</title>
+  <title>ensure_folder_exists &mdash; tk-core v0.20.31 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" />
@@ -85,7 +85,7 @@
                              text-decoration: underline; }
     </style>
 
-    <b>tk-core</b> v0.20.28.<br>
+    <b>tk-core</b> v0.20.31.<br>
 
         This documentation is part of the ShotGrid Pipeline Toolkit.
 
@@ -177,7 +177,7 @@ <h1>Source code for ensure_folder_exists</h1><div class="highlight"><pre>
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023, Autodesk.</p>
+    <p>&#169; Copyright 2024, Autodesk.</p>
   </div>
 
 

diff --git a/_modules/example_template_hook.html b/_modules/example_template_hook.html
@@ -5,7 +5,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>example_template_hook &mdash; tk-core v0.20.28 documentation</title>
+  <title>example_template_hook &mdash; tk-core v0.20.31 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" />
@@ -85,7 +85,7 @@
                              text-decoration: underline; }
     </style>
 
-    <b>tk-core</b> v0.20.28.<br>
+    <b>tk-core</b> v0.20.31.<br>
 
         This documentation is part of the ShotGrid Pipeline Toolkit.
 
@@ -195,7 +195,7 @@ <h1>Source code for example_template_hook</h1><div class="highlight"><pre>
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023, Autodesk.</p>
+    <p>&#169; Copyright 2024, Autodesk.</p>
   </div>
 
 

diff --git a/_modules/get_current_login.html b/_modules/get_current_login.html
@@ -5,7 +5,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>get_current_login &mdash; tk-core v0.20.28 documentation</title>
+  <title>get_current_login &mdash; tk-core v0.20.31 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" />
@@ -85,7 +85,7 @@
                              text-decoration: underline; }
     </style>
 
-    <b>tk-core</b> v0.20.28.<br>
+    <b>tk-core</b> v0.20.31.<br>
 
         This documentation is part of the ShotGrid Pipeline Toolkit.
 
@@ -196,7 +196,7 @@ <h1>Source code for get_current_login</h1><div class="highlight"><pre>
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023, Autodesk.</p>
+    <p>&#169; Copyright 2024, Autodesk.</p>
   </div>
 
 

diff --git a/_modules/index.html b/_modules/index.html
@@ -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-core v0.20.28 documentation</title>
+  <title>Overview: module code &mdash; tk-core v0.20.31 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" />
@@ -85,7 +85,7 @@
                              text-decoration: underline; }
     </style>
 
-    <b>tk-core</b> v0.20.28.<br>
+    <b>tk-core</b> v0.20.31.<br>
 
         This documentation is part of the ShotGrid Pipeline Toolkit.
 
@@ -199,7 +199,7 @@ <h1>All modules for which code is available</h1>
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023, Autodesk.</p>
+    <p>&#169; Copyright 2024, Autodesk.</p>
   </div>
 
 

diff --git a/_modules/log_metrics.html b/_modules/log_metrics.html
@@ -5,7 +5,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>log_metrics &mdash; tk-core v0.20.28 documentation</title>
+  <title>log_metrics &mdash; tk-core v0.20.31 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" />
@@ -85,7 +85,7 @@
                              text-decoration: underline; }
     </style>
 
-    <b>tk-core</b> v0.20.28.<br>
+    <b>tk-core</b> v0.20.31.<br>
 
         This documentation is part of the ShotGrid Pipeline Toolkit.
 
@@ -185,7 +185,7 @@ <h1>Source code for log_metrics</h1><div class="highlight"><pre>
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023, Autodesk.</p>
+    <p>&#169; Copyright 2024, Autodesk.</p>
   </div>
 
 

diff --git a/_modules/pick_environment.html b/_modules/pick_environment.html
@@ -5,7 +5,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>pick_environment &mdash; tk-core v0.20.28 documentation</title>
+  <title>pick_environment &mdash; tk-core v0.20.31 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" />
@@ -85,7 +85,7 @@
                              text-decoration: underline; }
     </style>
 
-    <b>tk-core</b> v0.20.28.<br>
+    <b>tk-core</b> v0.20.31.<br>
 
         This documentation is part of the ShotGrid Pipeline Toolkit.
 
@@ -181,7 +181,7 @@ <h1>Source code for pick_environment</h1><div class="highlight"><pre>
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023, Autodesk.</p>
+    <p>&#169; Copyright 2024, Autodesk.</p>
   </div>
 
 

diff --git a/_modules/pipeline_configuration_init.html b/_modules/pipeline_configuration_init.html
@@ -5,7 +5,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>pipeline_configuration_init &mdash; tk-core v0.20.28 documentation</title>
+  <title>pipeline_configuration_init &mdash; tk-core v0.20.31 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" />
@@ -85,7 +85,7 @@
                              text-decoration: underline; }
     </style>
 
-    <b>tk-core</b> v0.20.28.<br>
+    <b>tk-core</b> v0.20.31.<br>
 
         This documentation is part of the ShotGrid Pipeline Toolkit.
 
@@ -163,7 +163,7 @@ <h1>Source code for pipeline_configuration_init</h1><div class="highlight"><pre>
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023, Autodesk.</p>
+    <p>&#169; Copyright 2024, Autodesk.</p>
   </div>