Deploy preview for PR 82 🛫

pr-preview/pr-82/design/index.html

@@ -315,8 +315,8 @@ <h3>What other existing projects were considered?<a class="headerlink" href="#wh
 <p>There were two primary existing projects considered as potential
 solutions:</p>
 <ul class="simple">
-<li><p><a class="extlink-pypi reference external" href="https://pypi.org/project/wagon/">``wagon``</a></p></li>
-<li><p><a class="extlink-pypi reference external" href="https://pypi.org/project/conda-pack/">``conda-pack``</a></p></li>
+<li><p><a class="extlink-pypi reference external" href="https://pypi.org/project/wagon/">wagon</a></p></li>
+<li><p><a class="extlink-pypi reference external" href="https://pypi.org/project/conda-pack/">conda-pack</a></p></li>
 </ul>
 <p>Similar to <code class="docutils literal notranslate"><span class="pre">venvstacks</span></code>, <code class="docutils literal notranslate"><span class="pre">wagon</span></code> aims to avoid needing to download
 Python packages on the target deployment system. However, it does
@@ -347,13 +347,13 @@ <h3>What other existing projects were considered?<a class="headerlink" href="#wh
 <h2>Technical<a class="headerlink" href="#technical" title="Link to this heading">¶</a></h2>
 <section id="why-use-python-build-standalone-for-the-base-runtimes">
 <h3>Why use <code class="docutils literal notranslate"><span class="pre">python-build-standalone</span></code> for the base runtimes?<a class="headerlink" href="#why-use-python-build-standalone-for-the-base-runtimes" title="Link to this heading">¶</a></h3>
-<p>The short answer to this question is “Because that’s what <a class="extlink-pypi reference external" href="https://pypi.org/project/pdm/">``pdm``</a> uses,
+<p>The short answer to this question is “Because that’s what <a class="extlink-pypi reference external" href="https://pypi.org/project/pdm/">pdm</a> uses,
 and <code class="docutils literal notranslate"><span class="pre">venvstacks</span></code> was already using <code class="docutils literal notranslate"><span class="pre">pdm</span></code> as its project management tool”.</p>
 <p>The longer answer is that there’s a genuinely strong alignment between the
 properties that the <code class="docutils literal notranslate"><span class="pre">python-build-standalone</span></code> maintainers aim to provide
 in their published binaries, and the characteristics that <code class="docutils literal notranslate"><span class="pre">venvstacks</span></code>
 needs in its base runtime layers.</p>
-<p>Supporting additional base runtime layer providers (such as <a class="extlink-pypi reference external" href="https://pypi.org/project/conda/">``conda``</a>)
+<p>Supporting additional base runtime layer providers (such as <a class="extlink-pypi reference external" href="https://pypi.org/project/conda/">conda</a>)
 could be a genuinely interesting capability, but there are no current
 plans to implement such a mechanism.</p>
 </section>

pr-preview/pr-82/development/index.html

@@ -319,7 +319,7 @@ <h3>Get the source code<a class="headerlink" href="#get-the-source-code" title="
 <section id="development-environment">
 <h3>Development Environment<a class="headerlink" href="#development-environment" title="Link to this heading">¶</a></h3>
 <p>In order to work on venvstacks, you need to install
-<a class="extlink-pypi reference external" href="https://pypi.org/project/pdm/">``pdm``</a>, <a class="extlink-pypi reference external" href="https://pypi.org/project/tox/">``tox``</a>, <a class="extlink-pypi reference external" href="https://pypi.org/project/tox-pdm/">``tox-pdm``</a>, and <a class="extlink-pypi reference external" href="https://pypi.org/project/scriv/">``scriv``</a>
+<a class="extlink-pypi reference external" href="https://pypi.org/project/pdm/">pdm</a>, <a class="extlink-pypi reference external" href="https://pypi.org/project/tox/">tox</a>, <a class="extlink-pypi reference external" href="https://pypi.org/project/tox-pdm/">tox-pdm</a>, and <a class="extlink-pypi reference external" href="https://pypi.org/project/scriv/">scriv</a>
 (everything else can be executed via <code class="docutils literal notranslate"><span class="pre">tox</span></code> environments).</p>
 <p>Given these tools, the default development environment can be set up
 and other commands executed as described below.</p>
@@ -352,7 +352,7 @@ <h3>Running from the source tree<a class="headerlink" href="#running-from-the-so
 </section>
 <section id="building-documentation">
 <h3>Building Documentation<a class="headerlink" href="#building-documentation" title="Link to this heading">¶</a></h3>
-<p>pip’s documentation is built using <a class="extlink-pypi reference external" href="https://pypi.org/project/Sphinx/">``Sphinx``</a>. The documentation is written
+<p>pip’s documentation is built using <a class="extlink-pypi reference external" href="https://pypi.org/project/Sphinx/">Sphinx</a>. The documentation is written
 in reStructuredText.</p>
 <p>To build it locally, run:</p>
 <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>tox<span class="w"> </span>-e<span class="w"> </span>docs
@@ -362,7 +362,7 @@ <h3>Building Documentation<a class="headerlink" href="#building-documentation" t
 </section>
 <section id="changelog-entries">
 <h3>Changelog Entries<a class="headerlink" href="#changelog-entries" title="Link to this heading">¶</a></h3>
-<p>The <code class="docutils literal notranslate"><span class="pre">venvstacks</span></code> changelog is managed with <a class="extlink-pypi reference external" href="https://pypi.org/project/scriv/">``scriv``</a>.</p>
+<p>The <code class="docutils literal notranslate"><span class="pre">venvstacks</span></code> changelog is managed with <a class="extlink-pypi reference external" href="https://pypi.org/project/scriv/">scriv</a>.</p>
 <p>All changes which may affect <code class="docutils literal notranslate"><span class="pre">venvstacks</span></code> users should be
 given a user facing changelog entry with <code class="docutils literal notranslate"><span class="pre">scriv</span> <span class="pre">create</span></code>.</p>
 <p>Entries are written in <code class="docutils literal notranslate"><span class="pre">.rst</span></code> format by default, so they
@@ -382,8 +382,8 @@ <h3>Changelog Entries<a class="headerlink" href="#changelog-entries" title="Link
 <h2>Automated Testing<a class="headerlink" href="#automated-testing" title="Link to this heading">¶</a></h2>
 <section id="code-consistency-checks">
 <h3>Code consistency checks<a class="headerlink" href="#code-consistency-checks" title="Link to this heading">¶</a></h3>
-<p>The project source code is autoformatted and linted using <a class="extlink-pypi reference external" href="https://pypi.org/project/ruff/">``ruff``</a>.
-It also uses <a class="extlink-pypi reference external" href="https://pypi.org/project/mypy/">``mypy``</a> in strict mode to statically check that Python APIs
+<p>The project source code is autoformatted and linted using <a class="extlink-pypi reference external" href="https://pypi.org/project/ruff/">ruff</a>.
+It also uses <a class="extlink-pypi reference external" href="https://pypi.org/project/mypy/">mypy</a> in strict mode to statically check that Python APIs
 are being accessed as expected.</p>
 <p>All of these commands can be invoked via tox:</p>
 <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>tox<span class="w"> </span>-e<span class="w"> </span>format
@@ -410,8 +410,8 @@ <h3>Code consistency checks<a class="headerlink" href="#code-consistency-checks"
 </section>
 <section id="running-tests-locally">
 <h3>Running tests locally<a class="headerlink" href="#running-tests-locally" title="Link to this heading">¶</a></h3>
-<p>The project’s tests are written using the <a class="extlink-pypi reference external" href="https://pypi.org/project/pytest/">``pytest``</a> test framework and the
-standard library’s <a class="reference external" href="https://docs.python.org/3/library/unittest.html#module-unittest" title="(in Python v3.13)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">unittest</span></code></a> module. <a class="extlink-pypi reference external" href="https://pypi.org/project/tox/">``tox``</a> is used to automate the
+<p>The project’s tests are written using the <a class="extlink-pypi reference external" href="https://pypi.org/project/pytest/">pytest</a> test framework and the
+standard library’s <a class="reference external" href="https://docs.python.org/3/library/unittest.html#module-unittest" title="(in Python v3.13)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">unittest</span></code></a> module. <a class="extlink-pypi reference external" href="https://pypi.org/project/tox/">tox</a> is used to automate the
 setup and execution of these tests across multiple Python versions.</p>
 <p>Some of the tests build and deploy full environment stacks, which makes them
 take a long time to run (5+ minutes for the sample project build and export,

pr-preview/pr-82/file-formats/index.html

@@ -402,7 +402,7 @@ <h3>Common layer specification fields<a class="headerlink" href="#common-layer-s
 <h3>Runtime layer specification fields<a class="headerlink" href="#runtime-layer-specification-fields" title="Link to this heading">¶</a></h3>
 <p>Runtime layer specifications must contain the following additional field:</p>
 <ul class="simple">
-<li><p><code class="docutils literal notranslate"><span class="pre">fully_versioned_name</span></code> (<a class="extlink-toml reference external" href="https://toml.io/en/v1.0.0#string">string</a>): the <a class="extlink-pypi reference external" href="https://pypi.org/project/pbs-installer/">``pbs-installer``</a> name
+<li><p><code class="docutils literal notranslate"><span class="pre">fully_versioned_name</span></code> (<a class="extlink-toml reference external" href="https://toml.io/en/v1.0.0#string">string</a>): the <a class="extlink-pypi reference external" href="https://pypi.org/project/pbs-installer/">pbs-installer</a> name
 of the Python runtime to be installed as the base runtime for this layer
 (and any upper layers that depend on this layer).</p></li>
 </ul>

pr-preview/pr-82/index.html

@@ -321,7 +321,7 @@ <h1>Virtual Environment Stacks<a class="headerlink" href="#virtual-environment-s
 <p>Refer to the <a class="reference internal" href="overview/#overview"><span class="std std-ref">Project Overview</span></a> for an example of
 specifying, locking, building, and publishing a set of environment stacks.</p>
 <p id="installing"><code class="docutils literal notranslate"><span class="pre">venvstacks</span></code> is available from the <a class="extlink-pypi reference external" href="https://pypi.org/project/venvstacks/">Python Package Index</a>,
-and can be installed with <a class="extlink-pypi reference external" href="https://pypi.org/project/pipx/">``pipx``</a> (or similar tools):</p>
+and can be installed with <a class="extlink-pypi reference external" href="https://pypi.org/project/pipx/">pipx</a> (or similar tools):</p>
 <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>pipx<span class="w"> </span>install<span class="w"> </span>venvstacks
 </pre></div>
 </div>