Skip to content

Commit

Permalink
Auto-updated documentation based on tag v2.7.1
Browse files Browse the repository at this point in the history
  • Loading branch information
@Shotgun-Rundeck
Shotgun-Rundeck committed Mar 26, 2024
1 parent 0f97324 commit abb6d45
Show file tree
Hide file tree
Showing 30 changed files with 47 additions and 47 deletions.
Binary file modified .doctrees/api.doctree
View file
Binary file not shown.
Binary file modified .doctrees/application.doctree
View file
Binary file not shown.
Binary file modified .doctrees/customizing.doctree
View file
Binary file not shown.
Binary file modified .doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified .doctrees/index.doctree
View file
Binary file not shown.
Binary file modified .doctrees/logging.doctree
View file
Binary file not shown.
Binary file modified .doctrees/utility.doctree
View file
Binary file not shown.
4 changes: 2 additions & 2 deletions _modules/app.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -84,10 +84,10 @@

<b>tk-multi-publish2</b> v2.7.1.<br>

This documentation is part of the ShotGrid Pipeline Toolkit.
This documentation is part of the Flow Production Tracking.

For more information, please visit
<a class=custom_post_menu href='https://help.autodesk.com/view/SGDEV/ENU/'>The ShotGrid developer portal.</a>.
<a class=custom_post_menu href='https://help.autodesk.com/view/SGDEV/ENU/'>The Flow Production Tracking developer portal.</a>.
The code associated with this documentation can be found
<a class=custom_post_menu href='https://github.com/shotgunsoftware/tk-multi-publish2'>here</a>.

Expand Down
4 changes: 2 additions & 2 deletions _modules/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -84,10 +84,10 @@

<b>tk-multi-publish2</b> v2.7.1.<br>

This documentation is part of the ShotGrid Pipeline Toolkit.
This documentation is part of the Flow Production Tracking.

For more information, please visit
<a class=custom_post_menu href='https://help.autodesk.com/view/SGDEV/ENU/'>The ShotGrid developer portal.</a>.
<a class=custom_post_menu href='https://help.autodesk.com/view/SGDEV/ENU/'>The Flow Production Tracking developer portal.</a>.
The code associated with this documentation can be found
<a class=custom_post_menu href='https://github.com/shotgunsoftware/tk-multi-publish2'>here</a>.

Expand Down
4 changes: 2 additions & 2 deletions _modules/tk_multi_publish2/api/data.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -84,10 +84,10 @@

<b>tk-multi-publish2</b> v2.7.1.<br>

This documentation is part of the ShotGrid Pipeline Toolkit.
This documentation is part of the Flow Production Tracking.

For more information, please visit
<a class=custom_post_menu href='https://help.autodesk.com/view/SGDEV/ENU/'>The ShotGrid developer portal.</a>.
<a class=custom_post_menu href='https://help.autodesk.com/view/SGDEV/ENU/'>The Flow Production Tracking developer portal.</a>.
The code associated with this documentation can be found
<a class=custom_post_menu href='https://github.com/shotgunsoftware/tk-multi-publish2'>here</a>.

Expand Down
4 changes: 2 additions & 2 deletions _modules/tk_multi_publish2/api/item.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -84,10 +84,10 @@

<b>tk-multi-publish2</b> v2.7.1.<br>

This documentation is part of the ShotGrid Pipeline Toolkit.
This documentation is part of the Flow Production Tracking.

For more information, please visit
<a class=custom_post_menu href='https://help.autodesk.com/view/SGDEV/ENU/'>The ShotGrid developer portal.</a>.
<a class=custom_post_menu href='https://help.autodesk.com/view/SGDEV/ENU/'>The Flow Production Tracking developer portal.</a>.
The code associated with this documentation can be found
<a class=custom_post_menu href='https://github.com/shotgunsoftware/tk-multi-publish2'>here</a>.

Expand Down
4 changes: 2 additions & 2 deletions _modules/tk_multi_publish2/api/manager.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -84,10 +84,10 @@

<b>tk-multi-publish2</b> v2.7.1.<br>

This documentation is part of the ShotGrid Pipeline Toolkit.
This documentation is part of the Flow Production Tracking.

For more information, please visit
<a class=custom_post_menu href='https://help.autodesk.com/view/SGDEV/ENU/'>The ShotGrid developer portal.</a>.
<a class=custom_post_menu href='https://help.autodesk.com/view/SGDEV/ENU/'>The Flow Production Tracking developer portal.</a>.
The code associated with this documentation can be found
<a class=custom_post_menu href='https://github.com/shotgunsoftware/tk-multi-publish2'>here</a>.

Expand Down
4 changes: 2 additions & 2 deletions _modules/tk_multi_publish2/api/plugins/setting.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -84,10 +84,10 @@

<b>tk-multi-publish2</b> v2.7.1.<br>

This documentation is part of the ShotGrid Pipeline Toolkit.
This documentation is part of the Flow Production Tracking.

For more information, please visit
<a class=custom_post_menu href='https://help.autodesk.com/view/SGDEV/ENU/'>The ShotGrid developer portal.</a>.
<a class=custom_post_menu href='https://help.autodesk.com/view/SGDEV/ENU/'>The Flow Production Tracking developer portal.</a>.
The code associated with this documentation can be found
<a class=custom_post_menu href='https://github.com/shotgunsoftware/tk-multi-publish2'>here</a>.

Expand Down
4 changes: 2 additions & 2 deletions _modules/tk_multi_publish2/api/task.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -84,10 +84,10 @@

<b>tk-multi-publish2</b> v2.7.1.<br>

This documentation is part of the ShotGrid Pipeline Toolkit.
This documentation is part of the Flow Production Tracking.

For more information, please visit
<a class=custom_post_menu href='https://help.autodesk.com/view/SGDEV/ENU/'>The ShotGrid developer portal.</a>.
<a class=custom_post_menu href='https://help.autodesk.com/view/SGDEV/ENU/'>The Flow Production Tracking developer portal.</a>.
The code associated with this documentation can be found
<a class=custom_post_menu href='https://github.com/shotgunsoftware/tk-multi-publish2'>here</a>.

Expand Down
4 changes: 2 additions & 2 deletions _modules/tk_multi_publish2/api/tree.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -84,10 +84,10 @@

<b>tk-multi-publish2</b> v2.7.1.<br>

This documentation is part of the ShotGrid Pipeline Toolkit.
This documentation is part of the Flow Production Tracking.

For more information, please visit
<a class=custom_post_menu href='https://help.autodesk.com/view/SGDEV/ENU/'>The ShotGrid developer portal.</a>.
<a class=custom_post_menu href='https://help.autodesk.com/view/SGDEV/ENU/'>The Flow Production Tracking developer portal.</a>.
The code associated with this documentation can be found
<a class=custom_post_menu href='https://github.com/shotgunsoftware/tk-multi-publish2'>here</a>.

Expand Down
4 changes: 2 additions & 2 deletions _modules/tk_multi_publish2/base_hooks/collector.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -84,10 +84,10 @@

<b>tk-multi-publish2</b> v2.7.1.<br>

This documentation is part of the ShotGrid Pipeline Toolkit.
This documentation is part of the Flow Production Tracking.

For more information, please visit
<a class=custom_post_menu href='https://help.autodesk.com/view/SGDEV/ENU/'>The ShotGrid developer portal.</a>.
<a class=custom_post_menu href='https://help.autodesk.com/view/SGDEV/ENU/'>The Flow Production Tracking developer portal.</a>.
The code associated with this documentation can be found
<a class=custom_post_menu href='https://github.com/shotgunsoftware/tk-multi-publish2'>here</a>.

Expand Down
4 changes: 2 additions & 2 deletions _modules/tk_multi_publish2/base_hooks/post_phase.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -84,10 +84,10 @@

<b>tk-multi-publish2</b> v2.7.1.<br>

This documentation is part of the ShotGrid Pipeline Toolkit.
This documentation is part of the Flow Production Tracking.

For more information, please visit
<a class=custom_post_menu href='https://help.autodesk.com/view/SGDEV/ENU/'>The ShotGrid developer portal.</a>.
<a class=custom_post_menu href='https://help.autodesk.com/view/SGDEV/ENU/'>The Flow Production Tracking developer portal.</a>.
The code associated with this documentation can be found
<a class=custom_post_menu href='https://github.com/shotgunsoftware/tk-multi-publish2'>here</a>.

Expand Down
4 changes: 2 additions & 2 deletions _modules/tk_multi_publish2/base_hooks/publish_plugin.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -84,10 +84,10 @@

<b>tk-multi-publish2</b> v2.7.1.<br>

This documentation is part of the ShotGrid Pipeline Toolkit.
This documentation is part of the Flow Production Tracking.

For more information, please visit
<a class=custom_post_menu href='https://help.autodesk.com/view/SGDEV/ENU/'>The ShotGrid developer portal.</a>.
<a class=custom_post_menu href='https://help.autodesk.com/view/SGDEV/ENU/'>The Flow Production Tracking developer portal.</a>.
The code associated with this documentation can be found
<a class=custom_post_menu href='https://github.com/shotgunsoftware/tk-multi-publish2'>here</a>.

Expand Down
4 changes: 2 additions & 2 deletions _modules/tk_multi_publish2/util.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -84,10 +84,10 @@

<b>tk-multi-publish2</b> v2.7.1.<br>

This documentation is part of the ShotGrid Pipeline Toolkit.
This documentation is part of the Flow Production Tracking.

For more information, please visit
<a class=custom_post_menu href='https://help.autodesk.com/view/SGDEV/ENU/'>The ShotGrid developer portal.</a>.
<a class=custom_post_menu href='https://help.autodesk.com/view/SGDEV/ENU/'>The Flow Production Tracking developer portal.</a>.
The code associated with this documentation can be found
<a class=custom_post_menu href='https://github.com/shotgunsoftware/tk-multi-publish2'>here</a>.

Expand Down
Binary file modified _static/logo.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified _static/logo@2x.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified _static/logo_sg@2x.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions api.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -181,10 +181,10 @@

<b>tk-multi-publish2</b> v2.7.1.<br>

This documentation is part of the ShotGrid Pipeline Toolkit.
This documentation is part of the Flow Production Tracking.

For more information, please visit
<a class=custom_post_menu href='https://help.autodesk.com/view/SGDEV/ENU/'>The ShotGrid developer portal.</a>.
<a class=custom_post_menu href='https://help.autodesk.com/view/SGDEV/ENU/'>The Flow Production Tracking developer portal.</a>.
The code associated with this documentation can be found
<a class=custom_post_menu href='https://github.com/shotgunsoftware/tk-multi-publish2'>here</a>.

Expand Down Expand Up @@ -871,7 +871,7 @@
<dl class="py property">
<dt class="sig sig-object py" id="tk_multi_publish2.api.PublishItem.context">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">context</span></span><a class="headerlink" href="#tk_multi_publish2.api.PublishItem.context" title="Permalink to this definition"></a></dt>
<dd><p>The <a class="reference external" href="https://developers.shotgridsoftware.com/tk-core/core.html#sgtk.Context" title="(in tk-core vv0.20.34)"><code class="xref py py-class docutils literal notranslate"><span class="pre">sgtk.Context</span></code></a> associated with this item.</p>
<dd><p>The <a class="reference external" href="https://developers.shotgridsoftware.com/tk-core/core.html#sgtk.Context" title="(in tk-core vv0.21.0)"><code class="xref py py-class docutils literal notranslate"><span class="pre">sgtk.Context</span></code></a> associated with this item.</p>
<p>If no context has been explicitly set for this item, the context will be
inherited from the item’s parent. If none of this item’s parents have
had a context set explicitly, the publisher’s launch context will be
Expand Down
6 changes: 3 additions & 3 deletions application.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -94,10 +94,10 @@

<b>tk-multi-publish2</b> v2.7.1.<br>

This documentation is part of the ShotGrid Pipeline Toolkit.
This documentation is part of the Flow Production Tracking.

For more information, please visit
<a class=custom_post_menu href='https://help.autodesk.com/view/SGDEV/ENU/'>The ShotGrid developer portal.</a>.
<a class=custom_post_menu href='https://help.autodesk.com/view/SGDEV/ENU/'>The Flow Production Tracking developer portal.</a>.
The code associated with this documentation can be found
<a class=custom_post_menu href='https://github.com/shotgunsoftware/tk-multi-publish2'>here</a>.

Expand Down Expand Up @@ -139,7 +139,7 @@ <h1>App Interface<a class="headerlink" href="#app-interface" title="Permalink to
<dl class="py class">
<dt class="sig sig-object py" id="app.MultiPublish2">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">app.</span></span><span class="sig-name descname"><span class="pre">MultiPublish2</span></span><a class="reference internal" href="_modules/app.html#MultiPublish2"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#app.MultiPublish2" title="Permalink to this definition"></a></dt>
<dd><p>This is the <a class="reference external" href="https://developers.shotgridsoftware.com/tk-core/platform.html#sgtk.platform.Application" title="(in tk-core vv0.20.34)"><code class="xref py py-class docutils literal notranslate"><span class="pre">sgtk.platform.Application</span></code></a> subclass that defines the
<dd><p>This is the <a class="reference external" href="https://developers.shotgridsoftware.com/tk-core/platform.html#sgtk.platform.Application" title="(in tk-core vv0.21.0)"><code class="xref py py-class docutils literal notranslate"><span class="pre">sgtk.platform.Application</span></code></a> subclass that defines the
top-level publish2 interface.</p>
<p>Application instances are constructed by the toolkit launch process
and various factory methods such as <code class="xref py py-meth docutils literal notranslate"><span class="pre">start_engine()</span></code>.</p>
Expand Down
14 changes: 7 additions & 7 deletions customizing.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -112,10 +112,10 @@

<b>tk-multi-publish2</b> v2.7.1.<br>

This documentation is part of the ShotGrid Pipeline Toolkit.
This documentation is part of the Flow Production Tracking.

For more information, please visit
<a class=custom_post_menu href='https://help.autodesk.com/view/SGDEV/ENU/'>The ShotGrid developer portal.</a>.
<a class=custom_post_menu href='https://help.autodesk.com/view/SGDEV/ENU/'>The Flow Production Tracking developer portal.</a>.
The code associated with this documentation can be found
<a class=custom_post_menu href='https://github.com/shotgunsoftware/tk-multi-publish2'>here</a>.

Expand Down Expand Up @@ -168,15 +168,15 @@ <h1>Publish Customization<a class="headerlink" href="#publish-customization" tit
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>For more information on how to take over, subclass, and manage hooks,
see the <a class="reference external" href="https://developers.shotgridsoftware.com/tk-core/core.html#sgtk-hook-docs" title="(in tk-core vv0.20.34)"><span class="xref std std-ref">Hooks</span></a> documentation.</p>
see the <a class="reference external" href="https://developers.shotgridsoftware.com/tk-core/core.html#sgtk-hook-docs" title="(in tk-core vv0.21.0)"><span class="xref std std-ref">Hooks</span></a> documentation.</p>
</div>
<hr class="docutils" />
<section id="collector-hook-api">
<h3>Collector Hook API<a class="headerlink" href="#collector-hook-api" title="Permalink to this heading"></a></h3>
<dl class="py class">
<dt class="sig sig-object py" id="tk_multi_publish2.base_hooks.CollectorPlugin">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">tk_multi_publish2.base_hooks.</span></span><span class="sig-name descname"><span class="pre">CollectorPlugin</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">parent</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tk_multi_publish2/base_hooks/collector.html#CollectorPlugin"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tk_multi_publish2.base_hooks.CollectorPlugin" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://developers.shotgridsoftware.com/tk-core/core.html#sgtk.Hook" title="(in tk-core vv0.20.34)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Hook</span></code></a></p>
<dd><p>Bases: <a class="reference external" href="https://developers.shotgridsoftware.com/tk-core/core.html#sgtk.Hook" title="(in tk-core vv0.21.0)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Hook</span></code></a></p>
<p>This class defines the required interface for a collector plugin.
Collectors are used to gather individual files that are loaded via the
file browser or dragged and dropped into the Publish2 UI. It is also used
Expand Down Expand Up @@ -393,15 +393,15 @@ <h3>Collector Hook API<a class="headerlink" href="#collector-hook-api" title="Pe
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>For more information on how to take over, subclass, and manage hooks,
see the <a class="reference external" href="https://developers.shotgridsoftware.com/tk-core/core.html#sgtk-hook-docs" title="(in tk-core vv0.20.34)"><span class="xref std std-ref">Hooks</span></a> documentation.</p>
see the <a class="reference external" href="https://developers.shotgridsoftware.com/tk-core/core.html#sgtk-hook-docs" title="(in tk-core vv0.21.0)"><span class="xref std std-ref">Hooks</span></a> documentation.</p>
</div>
<hr class="docutils" />
<section id="publish-plugin-api">
<h3>Publish Plugin API<a class="headerlink" href="#publish-plugin-api" title="Permalink to this heading"></a></h3>
<dl class="py class">
<dt class="sig sig-object py" id="tk_multi_publish2.base_hooks.PublishPlugin">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">tk_multi_publish2.base_hooks.</span></span><span class="sig-name descname"><span class="pre">PublishPlugin</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">parent</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tk_multi_publish2/base_hooks/publish_plugin.html#PublishPlugin"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tk_multi_publish2.base_hooks.PublishPlugin" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://developers.shotgridsoftware.com/tk-core/core.html#sgtk.Hook" title="(in tk-core vv0.20.34)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Hook</span></code></a></p>
<dd><p>Bases: <a class="reference external" href="https://developers.shotgridsoftware.com/tk-core/core.html#sgtk.Hook" title="(in tk-core vv0.21.0)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Hook</span></code></a></p>
<p>This class defines the required interface for a publish plugin. Publish
plugins are responsible for operating on items collected by the collector
plugin. Publish plugins define which items they will operate on as well as
Expand Down Expand Up @@ -864,7 +864,7 @@ <h2>Post Phase Hook<a class="headerlink" href="#post-phase-hook" title="Permalin
<dl class="py class">
<dt class="sig sig-object py" id="tk_multi_publish2.base_hooks.PostPhaseHook">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">tk_multi_publish2.base_hooks.</span></span><span class="sig-name descname"><span class="pre">PostPhaseHook</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">parent</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tk_multi_publish2/base_hooks/post_phase.html#PostPhaseHook"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tk_multi_publish2.base_hooks.PostPhaseHook" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://developers.shotgridsoftware.com/tk-core/core.html#sgtk.Hook" title="(in tk-core vv0.20.34)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Hook</span></code></a></p>
<dd><p>Bases: <a class="reference external" href="https://developers.shotgridsoftware.com/tk-core/core.html#sgtk.Hook" title="(in tk-core vv0.21.0)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Hook</span></code></a></p>
<p>This hook defines methods that are executed after each phase of a publish:
validation, publish, and finalization. Each method receives the
<a class="reference internal" href="api.html#publish-api-tree"><span class="std std-ref">PublishTree</span></a> tree instance being used by the publisher, giving
Expand Down
4 changes: 2 additions & 2 deletions genindex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -84,10 +84,10 @@

<b>tk-multi-publish2</b> v2.7.1.<br>

This documentation is part of the ShotGrid Pipeline Toolkit.
This documentation is part of the Flow Production Tracking.

For more information, please visit
<a class=custom_post_menu href='https://help.autodesk.com/view/SGDEV/ENU/'>The ShotGrid developer portal.</a>.
<a class=custom_post_menu href='https://help.autodesk.com/view/SGDEV/ENU/'>The Flow Production Tracking developer portal.</a>.
The code associated with this documentation can be found
<a class=custom_post_menu href='https://github.com/shotgunsoftware/tk-multi-publish2'>here</a>.

Expand Down
Loading

0 comments on commit abb6d45

Please sign in to comment.