Skip to content

Commit

Permalink
Deploying to gh-pages from @ e176278 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
ncoghlan committed Nov 27, 2024
1 parent 32300ed commit 4e07770
Show file tree
Hide file tree
Showing 12 changed files with 10 additions and 26 deletions.
Binary file not shown.
Binary file modified .doctrees/api/stacks/venvstacks.stacks.FrameworkEnv.doctree
Binary file not shown.
Binary file modified .doctrees/api/stacks/venvstacks.stacks.LayerEnvBase.doctree
Binary file not shown.
Binary file modified .doctrees/api/stacks/venvstacks.stacks.LayerExportRequest.doctree
Binary file not shown.
Binary file modified .doctrees/environment.pickle
Binary file not shown.
2 changes: 0 additions & 2 deletions _sources/api/stacks/venvstacks.stacks.FrameworkEnv.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,8 @@ venvstacks.stacks.FrameworkEnv

.. autosummary::

~FrameworkEnv.create_archive
~FrameworkEnv.create_environment
~FrameworkEnv.define_archive_build
~FrameworkEnv.export_environment
~FrameworkEnv.get_constraint_paths
~FrameworkEnv.install_requirements
~FrameworkEnv.link_base_runtime
Expand Down
2 changes: 0 additions & 2 deletions _sources/api/stacks/venvstacks.stacks.LayerEnvBase.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,8 @@ venvstacks.stacks.LayerEnvBase

.. autosummary::

~LayerEnvBase.create_archive
~LayerEnvBase.create_environment
~LayerEnvBase.define_archive_build
~LayerEnvBase.export_environment
~LayerEnvBase.get_constraint_paths
~LayerEnvBase.install_requirements
~LayerEnvBase.lock_requirements
Expand Down
4 changes: 2 additions & 2 deletions api/stacks/venvstacks.stacks.ArchiveBuildRequest/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -296,13 +296,13 @@
<h1>venvstacks.stacks.ArchiveBuildRequest<a class="headerlink" href="#venvstacks-stacks-archivebuildrequest" title="Link to this heading"></a></h1>
<dl class="py class">
<dt class="sig sig-object py" id="venvstacks.stacks.ArchiveBuildRequest">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">venvstacks.stacks.</span></span><span class="sig-name descname"><span class="pre">ArchiveBuildRequest</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">env_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">EnvNameBuild</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">env_lock</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../venvstacks.stacks.EnvironmentLock/#venvstacks.stacks.EnvironmentLock" title="venvstacks.stacks.EnvironmentLock"><span class="pre">EnvironmentLock</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">archive_base_path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/pathlib.html#pathlib.Path" title="(in Python v3.13)"><span class="pre">Path</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">build_metadata</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../venvstacks.stacks.ArchiveBuildMetadata/#venvstacks.stacks.ArchiveBuildMetadata" title="venvstacks.stacks.ArchiveBuildMetadata"><span class="pre">ArchiveBuildMetadata</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">needs_build</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><span class="pre">bool</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#venvstacks.stacks.ArchiveBuildRequest" title="Link to this definition"></a></dt>
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">venvstacks.stacks.</span></span><span class="sig-name descname"><span class="pre">ArchiveBuildRequest</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">env_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">EnvNameBuild</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">env_lock</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../venvstacks.stacks.EnvironmentLock/#venvstacks.stacks.EnvironmentLock" title="venvstacks.stacks.EnvironmentLock"><span class="pre">EnvironmentLock</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">env_path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/pathlib.html#pathlib.Path" title="(in Python v3.13)"><span class="pre">Path</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">archive_base_path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/pathlib.html#pathlib.Path" title="(in Python v3.13)"><span class="pre">Path</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">build_metadata</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../venvstacks.stacks.ArchiveBuildMetadata/#venvstacks.stacks.ArchiveBuildMetadata" title="venvstacks.stacks.ArchiveBuildMetadata"><span class="pre">ArchiveBuildMetadata</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">needs_build</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><span class="pre">bool</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">archive_metadata</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../venvstacks.stacks.ArchiveMetadata/#venvstacks.stacks.ArchiveMetadata" title="venvstacks.stacks.ArchiveMetadata"><span class="pre">ArchiveMetadata</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#venvstacks.stacks.ArchiveBuildRequest" title="Link to this definition"></a></dt>
<dd><p>Structured request to build a named output archive.</p>
<p class="rubric">Methods</p>
<div class="table-wrapper autosummary longtable docutils container">
<table class="autosummary longtable docutils align-default">
<tbody>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">create_archive</span></code>(env_path[, ...])</p></td>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">create_archive</span></code>([work_path])</p></td>
<td><p>Create the layer archive specified in this build request.</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">define_build</span></code>(env_name, env_lock, ...[, ...])</p></td>
Expand Down
10 changes: 2 additions & 8 deletions api/stacks/venvstacks.stacks.FrameworkEnv/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -302,18 +302,12 @@ <h1>venvstacks.stacks.FrameworkEnv<a class="headerlink" href="#venvstacks-stacks
<div class="table-wrapper autosummary longtable docutils container">
<table class="autosummary longtable docutils align-default">
<tbody>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">create_archive</span></code>(output_path, target_platform)</p></td>
<td><p>Create a layer archive for this environment.</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">create_environment</span></code>([clean])</p></td>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">create_environment</span></code>([clean])</p></td>
<td><p>Create or update specified environment.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">define_archive_build</span></code>(output_path, ...[, ...])</p></td>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">define_archive_build</span></code>(output_path, ...[, ...])</p></td>
<td><p>Define an archive build request for this environment.</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">export_environment</span></code>(output_path[, ...])</p></td>
<td><p>Locally export this environment.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_constraint_paths</span></code>()</p></td>
<td><p>Get the lower level layer constraints imposed on this environment.</p></td>
</tr>
Expand Down
10 changes: 2 additions & 8 deletions api/stacks/venvstacks.stacks.LayerEnvBase/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -302,18 +302,12 @@ <h1>venvstacks.stacks.LayerEnvBase<a class="headerlink" href="#venvstacks-stacks
<div class="table-wrapper autosummary longtable docutils container">
<table class="autosummary longtable docutils align-default">
<tbody>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">create_archive</span></code>(output_path, target_platform)</p></td>
<td><p>Create a layer archive for this environment.</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">create_environment</span></code>([clean])</p></td>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">create_environment</span></code>([clean])</p></td>
<td><p>Create or update specified environment.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">define_archive_build</span></code>(output_path, ...[, ...])</p></td>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">define_archive_build</span></code>(output_path, ...[, ...])</p></td>
<td><p>Define an archive build request for this environment.</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">export_environment</span></code>(output_path[, ...])</p></td>
<td><p>Locally export this environment.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_constraint_paths</span></code>()</p></td>
<td><p>Get the lower level layer constraints imposed on this environment.</p></td>
</tr>
Expand Down
6 changes: 3 additions & 3 deletions api/stacks/venvstacks.stacks.LayerExportRequest/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -296,16 +296,16 @@
<h1>venvstacks.stacks.LayerExportRequest<a class="headerlink" href="#venvstacks-stacks-layerexportrequest" title="Link to this heading"></a></h1>
<dl class="py class">
<dt class="sig sig-object py" id="venvstacks.stacks.LayerExportRequest">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">venvstacks.stacks.</span></span><span class="sig-name descname"><span class="pre">LayerExportRequest</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">env_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">EnvNameBuild</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">env_lock</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../venvstacks.stacks.EnvironmentLock/#venvstacks.stacks.EnvironmentLock" title="venvstacks.stacks.EnvironmentLock"><span class="pre">EnvironmentLock</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">export_path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/pathlib.html#pathlib.Path" title="(in Python v3.13)"><span class="pre">Path</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">export_metadata</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../venvstacks.stacks.ExportMetadata/#venvstacks.stacks.ExportMetadata" title="venvstacks.stacks.ExportMetadata"><span class="pre">ExportMetadata</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">needs_export</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><span class="pre">bool</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#venvstacks.stacks.LayerExportRequest" title="Link to this definition"></a></dt>
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">venvstacks.stacks.</span></span><span class="sig-name descname"><span class="pre">LayerExportRequest</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">env_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">EnvNameBuild</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">env_lock</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../venvstacks.stacks.EnvironmentLock/#venvstacks.stacks.EnvironmentLock" title="venvstacks.stacks.EnvironmentLock"><span class="pre">EnvironmentLock</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">env_path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/pathlib.html#pathlib.Path" title="(in Python v3.13)"><span class="pre">Path</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">export_path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/pathlib.html#pathlib.Path" title="(in Python v3.13)"><span class="pre">Path</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">export_metadata</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../venvstacks.stacks.ExportMetadata/#venvstacks.stacks.ExportMetadata" title="venvstacks.stacks.ExportMetadata"><span class="pre">ExportMetadata</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">needs_export</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><span class="pre">bool</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#venvstacks.stacks.LayerExportRequest" title="Link to this definition"></a></dt>
<dd><p>Structured request to locally export an environment.</p>
<p class="rubric">Methods</p>
<div class="table-wrapper autosummary longtable docutils container">
<table class="autosummary longtable docutils align-default">
<tbody>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">define_export</span></code>(env_name, env_lock, output_path)</p></td>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">define_export</span></code>(env_name, env_lock, ...[, ...])</p></td>
<td><p>Define a new layer export request for the given environment.</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">export_environment</span></code>(env_path[, previous_metadata])</p></td>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">export_environment</span></code>()</p></td>
<td><p>Locally export the layer environment specified in this export request.</p></td>
</tr>
</tbody>
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

0 comments on commit 4e07770

Please sign in to comment.