Auto-updated documentation based on tag v2.8.0

shotgunsoftware · Mar 26, 2024 · e427481 · e427481
1 parent abb6d45
commit e427481
Show file tree

Hide file tree

Showing 33 changed files with 85 additions and 83 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: 2c1da5ce6654e8d20fc40ecd2738a516
+config: de906a6cc862e19aa24114b9499ef739
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/.doctrees/api.doctree b/.doctrees/api.doctree
diff --git a/.doctrees/application.doctree b/.doctrees/application.doctree
diff --git a/.doctrees/customizing.doctree b/.doctrees/customizing.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/logging.doctree b/.doctrees/logging.doctree
diff --git a/.doctrees/utility.doctree b/.doctrees/utility.doctree
diff --git a/_modules/app.html b/_modules/app.html
@@ -5,7 +5,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>app &mdash; tk-multi-publish2 v2.7.1 documentation</title>
+  <title>app &mdash; tk-multi-publish2 v2.8.0 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" />
@@ -82,7 +82,7 @@
                              text-decoration: underline; }
     </style>
 
-    <b>tk-multi-publish2</b> v2.7.1.<br>
+    <b>tk-multi-publish2</b> v2.8.0.<br>
 
         This documentation is part of the Flow Production Tracking.
 
@@ -184,7 +184,7 @@ <h1>Source code for app</h1><div class="highlight"><pre>
         <span class="n">menu_caption</span> <span class="o">=</span> <span class="s2">&quot;</span><span class="si">%s</span><span class="s2">...&quot;</span> <span class="o">%</span> <span class="n">display_name</span>
         <span class="n">menu_options</span> <span class="o">=</span> <span class="p">{</span>
             <span class="s2">&quot;short_name&quot;</span><span class="p">:</span> <span class="n">command_name</span><span class="p">,</span>
-            <span class="s2">&quot;description&quot;</span><span class="p">:</span> <span class="s2">&quot;Publishing of data to ShotGrid&quot;</span><span class="p">,</span>
+            <span class="s2">&quot;description&quot;</span><span class="p">:</span> <span class="s2">&quot;Publishing of data to Flow Production Tracking&quot;</span><span class="p">,</span>
             <span class="c1"># dark themed icon for engines that recognize this format</span>
             <span class="s2">&quot;icons&quot;</span><span class="p">:</span> <span class="p">{</span>
                 <span class="s2">&quot;dark&quot;</span><span class="p">:</span> <span class="p">{</span><span class="s2">&quot;png&quot;</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">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">disk_location</span><span class="p">,</span> <span class="s2">&quot;icon_256_dark.png&quot;</span><span class="p">)}</span>

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-multi-publish2 v2.7.1 documentation</title>
+  <title>Overview: module code &mdash; tk-multi-publish2 v2.8.0 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" />
@@ -82,7 +82,7 @@
                              text-decoration: underline; }
     </style>
 
-    <b>tk-multi-publish2</b> v2.7.1.<br>
+    <b>tk-multi-publish2</b> v2.8.0.<br>
 
         This documentation is part of the Flow Production Tracking.
 

diff --git a/_modules/tk_multi_publish2/api/data.html b/_modules/tk_multi_publish2/api/data.html
@@ -5,7 +5,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>tk_multi_publish2.api.data &mdash; tk-multi-publish2 v2.7.1 documentation</title>
+  <title>tk_multi_publish2.api.data &mdash; tk-multi-publish2 v2.8.0 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" />
@@ -82,7 +82,7 @@
                              text-decoration: underline; }
     </style>
 
-    <b>tk-multi-publish2</b> v2.7.1.<br>
+    <b>tk-multi-publish2</b> v2.8.0.<br>
 
         This documentation is part of the Flow Production Tracking.
 

diff --git a/_modules/tk_multi_publish2/api/item.html b/_modules/tk_multi_publish2/api/item.html
@@ -5,7 +5,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>tk_multi_publish2.api.item &mdash; tk-multi-publish2 v2.7.1 documentation</title>
+  <title>tk_multi_publish2.api.item &mdash; tk-multi-publish2 v2.8.0 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" />
@@ -82,7 +82,7 @@
                              text-decoration: underline; }
     </style>
 
-    <b>tk-multi-publish2</b> v2.7.1.<br>
+    <b>tk-multi-publish2</b> v2.8.0.<br>
 
         This documentation is part of the Flow Production Tracking.
 
@@ -1093,10 +1093,10 @@ <h1>Source code for tk_multi_publish2.api.item</h1><div class="highlight"><pre>
 <span class="sd">        The type specification for this item. This specification typically</span>
 <span class="sd">        follows a hierarchical dot notation. For example, &#39;file&#39;, &#39;file.image&#39;,</span>
 <span class="sd">        or &#39;file.movie&#39;. This allows for a system whereby some publish plugins</span>
-<span class="sd">        act on &#39;file.*&#39; items (publish to SG for example) while other plugins</span>
+<span class="sd">        act on &#39;file.*&#39; items (publish to PTR for example) while other plugins</span>
 <span class="sd">        may perform actions on a more specific set of items (for example</span>
 <span class="sd">        uploading the media represented by &#39;file.image&#39; or &#39;file.movie&#39; items to</span>
-<span class="sd">        SG as Versions). This is how the default integrations use this property</span>
+<span class="sd">        PTR as Versions). This is how the default integrations use this property</span>
 <span class="sd">        on collected items.</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_type_spec</span>

diff --git a/_modules/tk_multi_publish2/api/manager.html b/_modules/tk_multi_publish2/api/manager.html
@@ -5,7 +5,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>tk_multi_publish2.api.manager &mdash; tk-multi-publish2 v2.7.1 documentation</title>
+  <title>tk_multi_publish2.api.manager &mdash; tk-multi-publish2 v2.8.0 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" />
@@ -82,7 +82,7 @@
                              text-decoration: underline; }
     </style>
 
-    <b>tk-multi-publish2</b> v2.7.1.<br>
+    <b>tk-multi-publish2</b> v2.8.0.<br>
 
         This documentation is part of the Flow Production Tracking.
 

diff --git a/_modules/tk_multi_publish2/api/plugins/setting.html b/_modules/tk_multi_publish2/api/plugins/setting.html
@@ -5,7 +5,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>tk_multi_publish2.api.plugins.setting &mdash; tk-multi-publish2 v2.7.1 documentation</title>
+  <title>tk_multi_publish2.api.plugins.setting &mdash; tk-multi-publish2 v2.8.0 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" />
@@ -82,7 +82,7 @@
                              text-decoration: underline; }
     </style>
 
-    <b>tk-multi-publish2</b> v2.7.1.<br>
+    <b>tk-multi-publish2</b> v2.8.0.<br>
 
         This documentation is part of the Flow Production Tracking.
 

diff --git a/_modules/tk_multi_publish2/api/task.html b/_modules/tk_multi_publish2/api/task.html
@@ -5,7 +5,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>tk_multi_publish2.api.task &mdash; tk-multi-publish2 v2.7.1 documentation</title>
+  <title>tk_multi_publish2.api.task &mdash; tk-multi-publish2 v2.8.0 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" />
@@ -82,7 +82,7 @@
                              text-decoration: underline; }
     </style>
 
-    <b>tk-multi-publish2</b> v2.7.1.<br>
+    <b>tk-multi-publish2</b> v2.8.0.<br>
 
         This documentation is part of the Flow Production Tracking.
 

diff --git a/_modules/tk_multi_publish2/api/tree.html b/_modules/tk_multi_publish2/api/tree.html
@@ -5,7 +5,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>tk_multi_publish2.api.tree &mdash; tk-multi-publish2 v2.7.1 documentation</title>
+  <title>tk_multi_publish2.api.tree &mdash; tk-multi-publish2 v2.8.0 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" />
@@ -82,7 +82,7 @@
                              text-decoration: underline; }
     </style>
 
-    <b>tk-multi-publish2</b> v2.7.1.<br>
+    <b>tk-multi-publish2</b> v2.8.0.<br>
 
         This documentation is part of the Flow Production Tracking.
 

diff --git a/_modules/tk_multi_publish2/base_hooks/collector.html b/_modules/tk_multi_publish2/base_hooks/collector.html
@@ -5,7 +5,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>tk_multi_publish2.base_hooks.collector &mdash; tk-multi-publish2 v2.7.1 documentation</title>
+  <title>tk_multi_publish2.base_hooks.collector &mdash; tk-multi-publish2 v2.8.0 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" />
@@ -82,7 +82,7 @@
                              text-decoration: underline; }
     </style>
 
-    <b>tk-multi-publish2</b> v2.7.1.<br>
+    <b>tk-multi-publish2</b> v2.8.0.<br>
 
         This documentation is part of the Flow Production Tracking.
 

diff --git a/_modules/tk_multi_publish2/base_hooks/post_phase.html b/_modules/tk_multi_publish2/base_hooks/post_phase.html
@@ -5,7 +5,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>tk_multi_publish2.base_hooks.post_phase &mdash; tk-multi-publish2 v2.7.1 documentation</title>
+  <title>tk_multi_publish2.base_hooks.post_phase &mdash; tk-multi-publish2 v2.8.0 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" />
@@ -82,7 +82,7 @@
                              text-decoration: underline; }
     </style>
 
-    <b>tk-multi-publish2</b> v2.7.1.<br>
+    <b>tk-multi-publish2</b> v2.8.0.<br>
 
         This documentation is part of the Flow Production Tracking.
 

diff --git a/_modules/tk_multi_publish2/base_hooks/publish_plugin.html b/_modules/tk_multi_publish2/base_hooks/publish_plugin.html
@@ -5,7 +5,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>tk_multi_publish2.base_hooks.publish_plugin &mdash; tk-multi-publish2 v2.7.1 documentation</title>
+  <title>tk_multi_publish2.base_hooks.publish_plugin &mdash; tk-multi-publish2 v2.8.0 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" />
@@ -82,7 +82,7 @@
                              text-decoration: underline; }
     </style>
 
-    <b>tk-multi-publish2</b> v2.7.1.<br>
+    <b>tk-multi-publish2</b> v2.8.0.<br>
 
         This documentation is part of the Flow Production Tracking.
 

diff --git a/_modules/tk_multi_publish2/util.html b/_modules/tk_multi_publish2/util.html
@@ -5,7 +5,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>tk_multi_publish2.util &mdash; tk-multi-publish2 v2.7.1 documentation</title>
+  <title>tk_multi_publish2.util &mdash; tk-multi-publish2 v2.8.0 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" />
@@ -82,7 +82,7 @@
                              text-decoration: underline; }
     </style>
 
-    <b>tk-multi-publish2</b> v2.7.1.<br>
+    <b>tk-multi-publish2</b> v2.8.0.<br>
 
         This documentation is part of the Flow Production Tracking.
 
@@ -396,13 +396,13 @@ <h1>Source code for tk_multi_publish2.util</h1><div class="highlight"><pre>
 
 <span class="k">def</span> <span class="nf">get_conflicting_publishes</span><span class="p">(</span><span class="n">context</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">publish_name</span><span class="p">,</span> <span class="n">filters</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
-<span class="sd">    Returns a list of SG published file dicts for any existing publishes that</span>
+<span class="sd">    Returns a list of PTR published file dicts for any existing publishes that</span>
 <span class="sd">    match the supplied context, path, and publish_name.</span>
 
 <span class="sd">    :param context: The context to search publishes for</span>
 <span class="sd">    :param path: The path to match against previous publishes</span>
 <span class="sd">    :param publish_name: The name of the publish.</span>
-<span class="sd">    :param filters: A list of additional SG find() filters to apply to the</span>
+<span class="sd">    :param filters: A list of additional PTR find() filters to apply to the</span>
 <span class="sd">        publish search.</span>
 
 <span class="sd">    :return: A list of ``dict``s representing existing publishes that match</span>
@@ -425,7 +425,7 @@ <h1>Source code for tk_multi_publish2.util</h1><div class="highlight"><pre>
     <span class="c1"># a workaround for our inability to filter publishes by path. so for now,</span>
     <span class="c1"># get a dictionary of data that would be used to create a matching publish</span>
     <span class="c1"># and use that to get publishes via a call to find(). Then we&#39;ll filter</span>
-    <span class="c1"># those by their path field. Once we have the ability in SG to filter by</span>
+    <span class="c1"># those by their path field. Once we have the ability in PTR to filter by</span>
     <span class="c1"># path, we can replace this whole method with a simple call to find().</span>
     <span class="n">publish_data</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">register_publish</span><span class="p">(</span>
         <span class="n">publisher</span><span class="o">.</span><span class="n">sgtk</span><span class="p">,</span> <span class="n">context</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">publish_name</span><span class="p">,</span> <span class="n">version_number</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">dry_run</span><span class="o">=</span><span class="kc">True</span>
@@ -467,7 +467,7 @@ <h1>Source code for tk_multi_publish2.util</h1><div class="highlight"><pre>
 
 <span class="sd">    The loader app respects the status of publishes to determine which are</span>
 <span class="sd">    available for the user to load in their DCC. Because it is possible to</span>
-<span class="sd">    create a version entry in SG with the same path multiple times, this method</span>
+<span class="sd">    create a version entry in PTR with the same path multiple times, this method</span>
 <span class="sd">    provides an easy way to clear the status of previous publishes for a given</span>
 <span class="sd">    path.</span>
 

diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt
@@ -1,5 +1,5 @@
-ShotGrid Publisher API reference, |release|
-###########################################
+Flow Production Tracking Publisher API reference, |release|
+###########################################################
 
 Overview
 ********
@@ -36,12 +36,13 @@ Collection & Acceptance
 
 When the Publisher is launched, the current session (Maya, Nuke, Houdini, etc)
 is processed and publish items are collected for display in the Publish app's
-interface. These items represent what the artists may want to track in ShotGrid
-and/or share with other artists by way of publishing. Similarly, as files are
-dragged and dropped onto the publish UI, they are processed and collected as publish
-items. This item collection behavior is defined by the app's collector hook and
-can be taken over or modified by studios to customize what data should be
-tracked in ShotGrid and how it should be shared between artists.
+interface. These items represent what the artists may want to track in
+Flow Production Tracking and/or share with other artists by way of publishing.
+Similarly, as files are dragged and dropped onto the publish UI, they are
+processed and collected as publish items. This item collection behavior is
+defined by the app's collector hook and can be taken over or modified by
+studios to customize what data should be tracked in Flow Production Tracking
+and how it should be shared between artists.
 
 .. note:: For a deeper dive into the collection behavior and how it can be
     customized, see the :ref:`publish-collector` docs.

diff --git a/_sources/logging.rst.txt b/_sources/logging.rst.txt
@@ -104,10 +104,10 @@ of the publish UI.
 
 ----
 
-Show in ShotGrid Action
------------------------
+Show in Flow Production Tracking Action
+---------------------------------------
 
-A common action for showing an entity's detail page in ShotGrid.
+A common action for showing an entity's detail page in Flow Production Tracking.
 
 The :class:`dict` supplied takes the following form::
 
@@ -122,8 +122,8 @@ The values in the :class:`dict` are:
 * ``label``: The text to display on the button itself. The default value is
   ``"Show Entity"``. Optional.
 * ``tooltip``: Optional tooltip text to display when the mouse is over the
-  button. The default value is ``"Reveal the entity in ShotGrid."``.
-* ``entity``: Required, standard ShotGrid entity :class:`dict`.
+  button. The default value is ``"Reveal the entity in Flow Production Tracking."``.
+* ``entity``: Required, standard Flow Production Tracking entity :class:`dict`.
 
 Example:
 

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: 'v2.7.1',
+    VERSION: 'v2.8.0',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',