Auto-updated documentation based on branch/tag v3.5.1

shotgunsoftware · Apr 4, 2024 · ed3fb1d · ed3fb1d
1 parent b6df757
commit ed3fb1d
Show file tree

Hide file tree

Showing 77 changed files with 13,628 additions and 735 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: 8f22a8c41bd9b065e7c4968525b99bc0
+config: 2911b455b01c0f8027910a3cf4cdc2cb
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/.doctrees/advanced.doctree b/.doctrees/advanced.doctree
diff --git a/.doctrees/advanced/iron_python.doctree b/.doctrees/advanced/iron_python.doctree
diff --git a/.doctrees/advanced/packaging.doctree b/.doctrees/advanced/packaging.doctree
diff --git a/.doctrees/authentication.doctree b/.doctrees/authentication.doctree
diff --git a/.doctrees/changelog.doctree b/.doctrees/changelog.doctree
diff --git a/.doctrees/cookbook.doctree b/.doctrees/cookbook.doctree
diff --git a/.doctrees/cookbook/attachments.doctree b/.doctrees/cookbook/attachments.doctree
diff --git a/.doctrees/cookbook/examples/ami_handler.doctree b/.doctrees/cookbook/examples/ami_handler.doctree
diff --git a/.doctrees/cookbook/examples/ami_version_packager.doctree b/.doctrees/cookbook/examples/ami_version_packager.doctree
diff --git a/.doctrees/cookbook/examples/basic_create_shot.doctree b/.doctrees/cookbook/examples/basic_create_shot.doctree
diff --git a/.doctrees/cookbook/examples/basic_create_shot_task_template.doctree b/.doctrees/cookbook/examples/basic_create_shot_task_template.doctree
diff --git a/.doctrees/cookbook/examples/basic_create_version_link_shot.doctree b/.doctrees/cookbook/examples/basic_create_version_link_shot.doctree
diff --git a/.doctrees/cookbook/examples/basic_delete_shot.doctree b/.doctrees/cookbook/examples/basic_delete_shot.doctree
diff --git a/.doctrees/cookbook/examples/basic_find_shot.doctree b/.doctrees/cookbook/examples/basic_find_shot.doctree
diff --git a/.doctrees/cookbook/examples/basic_sg_instance.doctree b/.doctrees/cookbook/examples/basic_sg_instance.doctree
diff --git a/.doctrees/cookbook/examples/basic_update_shot.doctree b/.doctrees/cookbook/examples/basic_update_shot.doctree
diff --git a/.doctrees/cookbook/examples/basic_upload_thumbnail_version.doctree b/.doctrees/cookbook/examples/basic_upload_thumbnail_version.doctree
diff --git a/.doctrees/cookbook/examples/svn_integration.doctree b/.doctrees/cookbook/examples/svn_integration.doctree
diff --git a/.doctrees/cookbook/smart_cut_fields.doctree b/.doctrees/cookbook/smart_cut_fields.doctree
diff --git a/.doctrees/cookbook/tasks.doctree b/.doctrees/cookbook/tasks.doctree
diff --git a/.doctrees/cookbook/tasks/split_tasks.doctree b/.doctrees/cookbook/tasks/split_tasks.doctree
diff --git a/.doctrees/cookbook/tasks/task_dependencies.doctree b/.doctrees/cookbook/tasks/task_dependencies.doctree
diff --git a/.doctrees/cookbook/tasks/updating_tasks.doctree b/.doctrees/cookbook/tasks/updating_tasks.doctree
diff --git a/.doctrees/cookbook/tutorials.doctree b/.doctrees/cookbook/tutorials.doctree
diff --git a/.doctrees/cookbook/usage_tips.doctree b/.doctrees/cookbook/usage_tips.doctree
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/.doctrees/index.doctree b/.doctrees/index.doctree
diff --git a/.doctrees/installation.doctree b/.doctrees/installation.doctree
diff --git a/.doctrees/reference.doctree b/.doctrees/reference.doctree
diff --git a/_modules/index.html b/_modules/index.html
@@ -5,17 +5,18 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Overview: module code &mdash; python-api v3.5.0 documentation</title>
+  <title>Overview: module code &mdash; python-api v3.5.1 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" />
   <!--[if lt IE 9]>
     <script src="../_static/js/html5shiv.min.js"></script>
   <![endif]-->
 
+        <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
         <script src="../_static/jquery.js"></script>
+        <script src="../_static/underscore.js"></script>
         <script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
-        <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
         <script src="../_static/doctools.js"></script>
         <script src="../_static/sphinx_highlight.js"></script>
     <script src="../_static/js/theme.js"></script>
@@ -82,7 +83,7 @@
                              text-decoration: underline; }
     </style>
 
-    <b>python-api</b> v3.5.0.<br>
+    <b>python-api</b> v3.5.1.<br>
 
     For more information, please visit
     <a class=custom_post_menu href='https://help.autodesk.com/view/SGDEV/ENU/'>The Flow Production Tracking developer portal.</a>.

diff --git a/_modules/logging.html b/_modules/logging.html
diff --git a/_modules/shotgun_api3/shotgun.html b/_modules/shotgun_api3/shotgun.html
diff --git a/_sources/reference.rst.txt b/_sources/reference.rst.txt
@@ -26,9 +26,9 @@ Shotgun()
 .. autoclass:: Shotgun
     :show-inheritance:
 
-********************************
-Flow Production Tracking Methods
-********************************
+***************
+Shotgun Methods
+***************
 
 The majority of functionality is contained within the :class:`~shotgun_api3.Shotgun` class. 
 The documentation for all of the methods you'll need in your scripts lives in here.
@@ -91,7 +91,7 @@ The documentation for all of the methods you'll need in your scripts lives in he
     Shotgun.followers
     Shotgun.following
 
-.. rubric:: Working with the Flow Production Tracking Schema and Preferences
+.. rubric:: Working with the Shotgun Schema and Preferences
 
 .. autosummary:: 
     :nosignatures:
@@ -177,10 +177,10 @@ Methods that relate to the activity stream and following of entities in Flow Pro
 .. automethod:: Shotgun.followers
 .. automethod:: Shotgun.following
 
-Working with the Flow Production Tracking Schema
-================================================
+Working with the Shotgun Schema
+===============================
 
-Methods allow you to introspect and modify the Flow Production Tracking schema.
+Methods allow you to introspect and modify the Shotgun schema.
 
 .. automethod:: Shotgun.schema_entity_read
 .. automethod:: Shotgun.schema_field_read

diff --git a/_static/_sphinx_javascript_frameworks_compat.js b/_static/_sphinx_javascript_frameworks_compat.js
@@ -1,9 +1,20 @@
-/* Compatability shim for jQuery and underscores.js.
+/*
+ * _sphinx_javascript_frameworks_compat.js
+ * ~~~~~~~~~~
+ *
+ * Compatability shim for jQuery and underscores.js.
+ *
+ * WILL BE REMOVED IN Sphinx 6.0
+ * xref RemovedInSphinx60Warning
  *
- * Copyright Sphinx contributors
- * Released under the two clause BSD licence
  */
 
+/**
+ * select a different prefix for underscore
+ */
+$u = _.noConflict();
+
+
 /**
  * small helper function to urldecode strings
  *

diff --git a/_static/basic.css b/_static/basic.css
@@ -4,7 +4,7 @@
  *
  * Sphinx stylesheet -- basic theme.
  *
- * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */
@@ -236,6 +236,16 @@ div.body p, div.body dd, div.body li, div.body blockquote {
 a.headerlink {
     visibility: hidden;
 }
+a.brackets:before,
+span.brackets > a:before{
+    content: "[";
+}
+
+a.brackets:after,
+span.brackets > a:after {
+    content: "]";
+}
+
 
 h1:hover > a.headerlink,
 h2:hover > a.headerlink,
@@ -324,17 +334,11 @@ aside.sidebar {
 p.sidebar-title {
     font-weight: bold;
 }
-
-nav.contents,
-aside.topic,
 div.admonition, div.topic, blockquote {
     clear: left;
 }
 
 /* -- topics ---------------------------------------------------------------- */
-
-nav.contents,
-aside.topic,
 div.topic {
     border: 1px solid #ccc;
     padding: 7px;
@@ -373,17 +377,13 @@ div.body p.centered {
 
 div.sidebar > :last-child,
 aside.sidebar > :last-child,
-nav.contents > :last-child,
-aside.topic > :last-child,
 div.topic > :last-child,
 div.admonition > :last-child {
     margin-bottom: 0;
 }
 
 div.sidebar::after,
 aside.sidebar::after,
-nav.contents::after,
-aside.topic::after,
 div.topic::after,
 div.admonition::after,
 blockquote::after {
@@ -608,27 +608,19 @@ ol.simple p,
 ul.simple p {
     margin-bottom: 0;
 }
-
-aside.footnote > span,
-div.citation > span {
+dl.footnote > dt,
+dl.citation > dt {
     float: left;
+    margin-right: 0.5em;
 }
-aside.footnote > span:last-of-type,
-div.citation > span:last-of-type {
-  padding-right: 0.5em;
-}
-aside.footnote > p {
-  margin-left: 2em;
-}
-div.citation > p {
-  margin-left: 4em;
-}
-aside.footnote > p:last-of-type,
-div.citation > p:last-of-type {
+
+dl.footnote > dd,
+dl.citation > dd {
     margin-bottom: 0em;
 }
-aside.footnote > p:last-of-type:after,
-div.citation > p:last-of-type:after {
+
+dl.footnote > dd:after,
+dl.citation > dd:after {
     content: "";
     clear: both;
 }
@@ -644,6 +636,10 @@ dl.field-list > dt {
     padding-left: 0.5em;
     padding-right: 5px;
 }
+dl.field-list > dt:after {
+    content: ":";
+}
+
 
 dl.field-list > dd {
     padding-left: 0.5em;

diff --git a/_static/doctools.js b/_static/doctools.js
@@ -4,7 +4,7 @@
  *
  * Base JavaScript utilities for all Sphinx HTML documentation.
  *
- * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */

diff --git a/_static/documentation_options.js b/_static/documentation_options.js
@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: 'v3.5.0',
+    VERSION: 'v3.5.1',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/_static/graphviz.css b/_static/graphviz.css
@@ -4,7 +4,7 @@
  *
  * Sphinx stylesheet -- graphviz extension.
  *
- * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */