Skip to content

Commit

Permalink
Auto-updated documentation based on tag v0.21.7
Browse files Browse the repository at this point in the history
  • Loading branch information
@Shotgun-Rundeck
Shotgun-Rundeck committed Sep 9, 2024
1 parent 276687b commit dfd1a33
Show file tree
Hide file tree
Showing 87 changed files with 212 additions and 191 deletions.
2 changes: 1 addition & 1 deletion .buildinfo
View file
Original file line number Diff line number Diff line change
@@ -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: 596d4c85f1f7a8c9f75553ff843d1e89
config: b7ede2fc81ada102aba708c0c14a417b
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified .doctrees/authentication.doctree
View file
Binary file not shown.
Binary file modified .doctrees/core.doctree
View file
Binary file not shown.
Binary file modified .doctrees/descriptor.doctree
View file
Binary file not shown.
Binary file modified .doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified .doctrees/environment_variables.doctree
View file
Binary file not shown.
Binary file modified .doctrees/index.doctree
View file
Binary file not shown.
Binary file modified .doctrees/initializing.doctree
View file
Binary file not shown.
Binary file modified .doctrees/overview.doctree
View file
Binary file not shown.
Binary file modified .doctrees/platform.doctree
View file
Binary file not shown.
Binary file modified .doctrees/utils.doctree
View file
Binary file not shown.
4 changes: 2 additions & 2 deletions _modules/before_register_publish.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.21.6 documentation</title>
<title>before_register_publish &mdash; tk-core v0.21.7 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" />
Expand Down Expand Up @@ -85,7 +85,7 @@
text-decoration: underline; }
</style>

<b>tk-core</b> v0.21.6.<br>
<b>tk-core</b> v0.21.7.<br>

This documentation is part of the Flow Production Tracking.

Expand Down
4 changes: 2 additions & 2 deletions _modules/bootstrap.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.21.6 documentation</title>
<title>bootstrap &mdash; tk-core v0.21.7 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" />
Expand Down Expand Up @@ -85,7 +85,7 @@
text-decoration: underline; }
</style>

<b>tk-core</b> v0.21.6.<br>
<b>tk-core</b> v0.21.7.<br>

This documentation is part of the Flow Production Tracking.

Expand Down
4 changes: 2 additions & 2 deletions _modules/bundle_init.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.21.6 documentation</title>
<title>bundle_init &mdash; tk-core v0.21.7 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" />
Expand Down Expand Up @@ -85,7 +85,7 @@
text-decoration: underline; }
</style>

<b>tk-core</b> v0.21.6.<br>
<b>tk-core</b> v0.21.7.<br>

This documentation is part of the Flow Production Tracking.

Expand Down
4 changes: 2 additions & 2 deletions _modules/cache_location.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.21.6 documentation</title>
<title>cache_location &mdash; tk-core v0.21.7 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" />
Expand Down Expand Up @@ -85,7 +85,7 @@
text-decoration: underline; }
</style>

<b>tk-core</b> v0.21.6.<br>
<b>tk-core</b> v0.21.7.<br>

This documentation is part of the Flow Production Tracking.

Expand Down
4 changes: 2 additions & 2 deletions _modules/context_change.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.21.6 documentation</title>
<title>context_change &mdash; tk-core v0.21.7 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" />
Expand Down Expand Up @@ -85,7 +85,7 @@
text-decoration: underline; }
</style>

<b>tk-core</b> v0.21.6.<br>
<b>tk-core</b> v0.21.7.<br>

This documentation is part of the Flow Production Tracking.

Expand Down
4 changes: 2 additions & 2 deletions _modules/default_storage_root.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.21.6 documentation</title>
<title>default_storage_root &mdash; tk-core v0.21.7 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" />
Expand Down Expand Up @@ -85,7 +85,7 @@
text-decoration: underline; }
</style>

<b>tk-core</b> v0.21.6.<br>
<b>tk-core</b> v0.21.7.<br>

This documentation is part of the Flow Production Tracking.

Expand Down
4 changes: 2 additions & 2 deletions _modules/engine_init.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.21.6 documentation</title>
<title>engine_init &mdash; tk-core v0.21.7 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" />
Expand Down Expand Up @@ -85,7 +85,7 @@
text-decoration: underline; }
</style>

<b>tk-core</b> v0.21.6.<br>
<b>tk-core</b> v0.21.7.<br>

This documentation is part of the Flow Production Tracking.

Expand Down
4 changes: 2 additions & 2 deletions _modules/ensure_folder_exists.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.21.6 documentation</title>
<title>ensure_folder_exists &mdash; tk-core v0.21.7 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" />
Expand Down Expand Up @@ -85,7 +85,7 @@
text-decoration: underline; }
</style>

<b>tk-core</b> v0.21.6.<br>
<b>tk-core</b> v0.21.7.<br>

This documentation is part of the Flow Production Tracking.

Expand Down
4 changes: 2 additions & 2 deletions _modules/example_template_hook.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.21.6 documentation</title>
<title>example_template_hook &mdash; tk-core v0.21.7 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" />
Expand Down Expand Up @@ -85,7 +85,7 @@
text-decoration: underline; }
</style>

<b>tk-core</b> v0.21.6.<br>
<b>tk-core</b> v0.21.7.<br>

This documentation is part of the Flow Production Tracking.

Expand Down
4 changes: 2 additions & 2 deletions _modules/get_current_login.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.21.6 documentation</title>
<title>get_current_login &mdash; tk-core v0.21.7 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" />
Expand Down Expand Up @@ -85,7 +85,7 @@
text-decoration: underline; }
</style>

<b>tk-core</b> v0.21.6.<br>
<b>tk-core</b> v0.21.7.<br>

This documentation is part of the Flow Production Tracking.

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 @@ -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.21.6 documentation</title>
<title>Overview: module code &mdash; tk-core v0.21.7 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" />
Expand Down Expand Up @@ -85,7 +85,7 @@
text-decoration: underline; }
</style>

<b>tk-core</b> v0.21.6.<br>
<b>tk-core</b> v0.21.7.<br>

This documentation is part of the Flow Production Tracking.

Expand Down
4 changes: 2 additions & 2 deletions _modules/log_metrics.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.21.6 documentation</title>
<title>log_metrics &mdash; tk-core v0.21.7 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" />
Expand Down Expand Up @@ -85,7 +85,7 @@
text-decoration: underline; }
</style>

<b>tk-core</b> v0.21.6.<br>
<b>tk-core</b> v0.21.7.<br>

This documentation is part of the Flow Production Tracking.

Expand Down
4 changes: 2 additions & 2 deletions _modules/pick_environment.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.21.6 documentation</title>
<title>pick_environment &mdash; tk-core v0.21.7 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" />
Expand Down Expand Up @@ -85,7 +85,7 @@
text-decoration: underline; }
</style>

<b>tk-core</b> v0.21.6.<br>
<b>tk-core</b> v0.21.7.<br>

This documentation is part of the Flow Production Tracking.

Expand Down
4 changes: 2 additions & 2 deletions _modules/pipeline_configuration_init.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.21.6 documentation</title>
<title>pipeline_configuration_init &mdash; tk-core v0.21.7 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" />
Expand Down Expand Up @@ -85,7 +85,7 @@
text-decoration: underline; }
</style>

<b>tk-core</b> v0.21.6.<br>
<b>tk-core</b> v0.21.7.<br>

This documentation is part of the Flow Production Tracking.

Expand Down
12 changes: 8 additions & 4 deletions _modules/process_folder_creation.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>process_folder_creation &mdash; tk-core v0.21.6 documentation</title>
<title>process_folder_creation &mdash; tk-core v0.21.7 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" />
Expand Down Expand Up @@ -85,7 +85,7 @@
text-decoration: underline; }
</style>

<b>tk-core</b> v0.21.6.<br>
<b>tk-core</b> v0.21.7.<br>

This documentation is part of the Flow Production Tracking.

Expand Down Expand Up @@ -148,9 +148,13 @@ <h1>Source code for process_folder_creation</h1><div class="highlight"><pre>
<span class="kn">import</span> <span class="nn">os</span>
<span class="kn">import</span> <span class="nn">sys</span>
<span class="kn">import</span> <span class="nn">shutil</span>
<span class="kn">from</span> <span class="nn">tank_vendor</span> <span class="kn">import</span> <span class="n">six</span>
<span class="kn">from</span> <span class="nn">tank.util</span> <span class="kn">import</span> <span class="n">is_windows</span>

<span class="k">try</span><span class="p">:</span>
<span class="kn">from</span> <span class="nn">tank_vendor</span> <span class="kn">import</span> <span class="n">sgutils</span>
<span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
<span class="kn">from</span> <span class="nn">tank_vendor</span> <span class="kn">import</span> <span class="n">six</span> <span class="k">as</span> <span class="n">sgutils</span>


<div class="viewcode-block" id="ProcessFolderCreation"><a class="viewcode-back" href="../core.html#process_folder_creation.ProcessFolderCreation">[docs]</a><span class="k">class</span> <span class="nc">ProcessFolderCreation</span><span class="p">(</span><span class="n">Hook</span><span class="p">):</span>
<div class="viewcode-block" id="ProcessFolderCreation.execute"><a class="viewcode-back" href="../core.html#process_folder_creation.ProcessFolderCreation.execute">[docs]</a> <span class="k">def</span> <span class="nf">execute</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">items</span><span class="p">,</span> <span class="n">preview_mode</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
Expand Down Expand Up @@ -316,7 +320,7 @@ <h1>Source code for process_folder_creation</h1><div class="highlight"><pre>
<span class="k">if</span> <span class="ow">not</span> <span class="n">preview_mode</span><span class="p">:</span>
<span class="c1"># create the file</span>
<span class="n">fp</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="s2">&quot;wb&quot;</span><span class="p">)</span>
<span class="n">fp</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">six</span><span class="o">.</span><span class="n">ensure_binary</span><span class="p">(</span><span class="n">content</span><span class="p">))</span>
<span class="n">fp</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">sgutils</span><span class="o">.</span><span class="n">ensure_binary</span><span class="p">(</span><span class="n">content</span><span class="p">))</span>
<span class="n">fp</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
<span class="c1"># and set permissions to open</span>
<span class="n">os</span><span class="o">.</span><span class="n">chmod</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="mo">0o666</span><span class="p">)</span>
Expand Down
4 changes: 2 additions & 2 deletions _modules/process_folder_name.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>process_folder_name &mdash; tk-core v0.21.6 documentation</title>
<title>process_folder_name &mdash; tk-core v0.21.7 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" />
Expand Down Expand Up @@ -85,7 +85,7 @@
text-decoration: underline; }
</style>

<b>tk-core</b> v0.21.6.<br>
<b>tk-core</b> v0.21.7.<br>

This documentation is part of the Flow Production Tracking.

Expand Down
4 changes: 2 additions & 2 deletions _modules/resolve_publish.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>resolve_publish &mdash; tk-core v0.21.6 documentation</title>
<title>resolve_publish &mdash; tk-core v0.21.7 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" />
Expand Down Expand Up @@ -85,7 +85,7 @@
text-decoration: underline; }
</style>

<b>tk-core</b> v0.21.6.<br>
<b>tk-core</b> v0.21.7.<br>

This documentation is part of the Flow Production Tracking.

Expand Down
4 changes: 2 additions & 2 deletions _modules/tank/api.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>tank.api &mdash; tk-core v0.21.6 documentation</title>
<title>tank.api &mdash; tk-core v0.21.7 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" />
Expand Down Expand Up @@ -85,7 +85,7 @@
text-decoration: underline; }
</style>

<b>tk-core</b> v0.21.6.<br>
<b>tk-core</b> v0.21.7.<br>

This documentation is part of the Flow Production Tracking.

Expand Down
4 changes: 2 additions & 2 deletions _modules/tank/authentication/defaults_manager.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>tank.authentication.defaults_manager &mdash; tk-core v0.21.6 documentation</title>
<title>tank.authentication.defaults_manager &mdash; tk-core v0.21.7 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" />
Expand Down Expand Up @@ -85,7 +85,7 @@
text-decoration: underline; }
</style>

<b>tk-core</b> v0.21.6.<br>
<b>tk-core</b> v0.21.7.<br>

This documentation is part of the Flow Production Tracking.

Expand Down
4 changes: 2 additions & 2 deletions _modules/tank/authentication/errors.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>tank.authentication.errors &mdash; tk-core v0.21.6 documentation</title>
<title>tank.authentication.errors &mdash; tk-core v0.21.7 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" />
Expand Down Expand Up @@ -85,7 +85,7 @@
text-decoration: underline; }
</style>

<b>tk-core</b> v0.21.6.<br>
<b>tk-core</b> v0.21.7.<br>

This documentation is part of the Flow Production Tracking.

Expand Down
Loading

0 comments on commit dfd1a33

Please sign in to comment.