Deployed e9ee590 to 2.11 with MkDocs 1.5.2 and mike 1.1.2

2.11/dev/fixtures/index.html

@@ -1663,8 +1663,8 @@ <h3 id="pdm.pytest.RunResult.exception" class="doc doc-heading">
 <code class="highlight language-python"><span class="n">exception</span><span class="p">:</span> <span class="ne">Exception</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span></code>
 
   <span class="doc doc-labels">
-      <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
       <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
+      <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
   </span>
 
 <a href="#pdm.pytest.RunResult.exception" class="headerlink" title="Permanent link">#</a></h3>

2.11/index.html

@@ -998,13 +998,13 @@ <h2 id="feature-highlights">Feature highlights<a class="headerlink" href="#featu
 <li>Opt-in centralized installation cache like <a href="https://pnpm.io/motivation#saving-disk-space-and-boosting-installation-speed">pnpm</a>.</li>
 </ul>
 <h2 id="installation">Installation<a class="headerlink" href="#installation" title="Permanent link">#</a></h2>
-<p>PDM requires Python 3.7+ to be installed. It works on multiple platforms including Windows, Linux and macOS.</p>
+<p>PDM requires Python 3.8+ to be installed. It works on multiple platforms including Windows, Linux and macOS.</p>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
 <p>You can still have your project working on lower Python versions, read how to do it <a href="usage/project/#working-with-python-37">here</a>.</p>
 </div>
 <h3 id="recommended-installation-method">Recommended installation method<a class="headerlink" href="#recommended-installation-method" title="Permanent link">#</a></h3>
-<p>PDM requires python version 3.7 or higher.</p>
+<p>PDM requires python version 3.8 or higher.</p>
 <p>Like Pip, PDM provides an installation script that will install PDM into an isolated environment.</p>
 <div class="tabbed-set tabbed-alternate" data-tabs="1:2"><input checked="checked" id="__tabbed_1_1" name="__tabbed_1" type="radio" /><input id="__tabbed_1_2" name="__tabbed_1" type="radio" /><div class="tabbed-labels"><label for="__tabbed_1_1">Linux/Mac</label><label for="__tabbed_1_2">Windows</label></div>
 <div class="tabbed-content">

2.11/reference/api/index.html

@@ -1738,8 +1738,8 @@ <h3 id="pdm.project.core.Project.config" class="doc doc-heading">
 <code class="highlight language-python"><span class="n">config</span><span class="p">:</span> <span class="n">Mapping</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]</span></code>
 
   <span class="doc doc-labels">
-      <small class="doc doc-label doc-label-property"><code>property</code></small>
       <small class="doc doc-label doc-label-cached"><code>cached</code></small>
+      <small class="doc doc-label doc-label-property"><code>property</code></small>
   </span>
 
 <a href="#pdm.project.core.Project.config" class="headerlink" title="Permanent link">#</a></h3>
@@ -1781,8 +1781,8 @@ <h3 id="pdm.project.core.Project.project_config" class="doc doc-heading">
 <code class="highlight language-python"><span class="n">project_config</span><span class="p">:</span> <span class="n">Config</span></code>
 
   <span class="doc doc-labels">
-      <small class="doc doc-label doc-label-property"><code>property</code></small>
       <small class="doc doc-label doc-label-cached"><code>cached</code></small>
+      <small class="doc doc-label doc-label-property"><code>property</code></small>
   </span>
 
 <a href="#pdm.project.core.Project.project_config" class="headerlink" title="Permanent link">#</a></h3>

2.11/reference/build/index.html

@@ -801,7 +801,7 @@ <h1 id="build-configuration">Build Configuration<a class="headerlink" href="#bui
 <p><code>pdm</code> uses the <a href="https://www.python.org/dev/peps/pep-0517/">PEP 517</a> to build the package. It acts as a build frontend that calls the build backend to build the package.</p>
 <p>A build backend is what drives the build system to build source distributions and wheels from arbitrary source trees.</p>
 <p>If you run <a href="../cli/#init"><code>pdm init</code></a>, PDM will let you choose the build backend to use. Unlike other package managers, PDM does not force you to use a specific build backend. You can choose the one you like. Here is a list of build backends and corresponding configurations initially supported by PDM:</p>
-<div class="tabbed-set tabbed-alternate" data-tabs="1:4"><input checked="checked" id="__tabbed_1_1" name="__tabbed_1" type="radio" /><input id="__tabbed_1_2" name="__tabbed_1" type="radio" /><input id="__tabbed_1_3" name="__tabbed_1" type="radio" /><input id="__tabbed_1_4" name="__tabbed_1" type="radio" /><div class="tabbed-labels"><label for="__tabbed_1_1">pdm-backend</label><label for="__tabbed_1_2">setuptools</label><label for="__tabbed_1_3">flit</label><label for="__tabbed_1_4">hatchling</label></div>
+<div class="tabbed-set tabbed-alternate" data-tabs="1:5"><input checked="checked" id="__tabbed_1_1" name="__tabbed_1" type="radio" /><input id="__tabbed_1_2" name="__tabbed_1" type="radio" /><input id="__tabbed_1_3" name="__tabbed_1" type="radio" /><input id="__tabbed_1_4" name="__tabbed_1" type="radio" /><input id="__tabbed_1_5" name="__tabbed_1" type="radio" /><div class="tabbed-labels"><label for="__tabbed_1_1">pdm-backend</label><label for="__tabbed_1_2">setuptools</label><label for="__tabbed_1_3">flit</label><label for="__tabbed_1_4">hatchling</label><label for="__tabbed_1_5">maturin</label></div>
 <div class="tabbed-content">
 <div class="tabbed-block">
 <p><code>pyproject.toml</code> configuration:</p>
@@ -843,6 +843,16 @@ <h1 id="build-configuration">Build Configuration<a class="headerlink" href="#bui
 </code></pre></div></td></tr></table></div>
 <p><a href="https://hatch.pypa.io/"><img alt="📖" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/twemoji@14.1.2/assets/svg/1f4d6.svg" title=":book:" /> Read the docs</a></p>
 </div>
+<div class="tabbed-block">
+<p><code>pyproject.toml</code> configuration:</p>
+<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
+<span class="normal">2</span>
+<span class="normal">3</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">[build-system]</span>
+<span class="n">requires</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">[</span><span class="s">&quot;maturin&gt;=1.4,&lt;2.0&quot;</span><span class="p">]</span>
+<span class="n">build-backend</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;maturin&quot;</span>
+</code></pre></div></td></tr></table></div>
+<p><a href="https://www.maturin.rs/"><img alt="📖" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/twemoji@14.1.2/assets/svg/1f4d6.svg" title=":book:" /> Read the docs</a></p>
+</div>
 </div>
 </div>
 <p>Apart from the above mentioned backends, you can also use any other backend that supports PEP 621, however, <a href="https://python-poetry.org/">poetry-core</a> is not supported because it does not support reading PEP 621 metadata.</p>

2.11/usage/advanced/index.html

@@ -1296,14 +1296,18 @@ <h3 id="check-pdmlock-is-up-to-date-with-pyprojecttoml">Check <code>pdm.lock</co
 <span class="w">    </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">id</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">pdm-lock-check</span>
 </code></pre></div></td></tr></table></div>
 <h3 id="sync-current-working-set-with-pdmlock">Sync current working set with <code>pdm.lock</code><a class="headerlink" href="#sync-current-working-set-with-pdmlock" title="Permanent link">#</a></h3>
-<p>This hook wraps the command <code>pdm sync</code> along with any valid argument. It can be used as a hook to ensure that your current working set is synced with <code>pdm.lock</code> whenever you checkout or merge a branch.</p>
+<p>This hook wraps the command <code>pdm sync</code> along with any valid argument. It can be used as a hook to ensure that your current working set is synced with <code>pdm.lock</code> whenever you checkout or merge a branch. Add <em>keyring</em> to <code>additional_dependencies</code> if you want to use your systems credential store.</p>
 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
 <span class="normal">2</span>
 <span class="normal">3</span>
-<span class="normal">4</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">repo</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://github.com/pdm-project/pdm</span>
+<span class="normal">4</span>
+<span class="normal">5</span>
+<span class="normal">6</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">repo</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://github.com/pdm-project/pdm</span>
 <span class="w">  </span><span class="nt">rev</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">2.x.y</span><span class="w"> </span><span class="c1"># a PDM release exposing the hook</span>
 <span class="w">  </span><span class="nt">hooks</span><span class="p">:</span>
 <span class="w">    </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">id</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">pdm-sync</span>
+<span class="w">      </span><span class="nt">additional_dependencies</span><span class="p">:</span>
+<span class="w">        </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">keyring</span>
 </code></pre></div></td></tr></table></div>
 
 

2.11/usage/dependency/index.html

@@ -1711,7 +1711,7 @@ <h3 id="include-and-exclude-groups">Include and exclude groups<a class="headerli
 <p>You can also pass <code>--resolve</code> to <code>pdm list</code>, which will show the packages resolved in <code>pdm.lock</code>, rather than installed in the working set.</p>
 <h3 id="change-the-output-fields-and-format">Change the output fields and format<a class="headerlink" href="#change-the-output-fields-and-format" title="Permanent link">#</a></h3>
 <p>By default, name, version and location will be shown in the list output, you can view more fields or specify the order of fields by <code>--fields</code> option:</p>
-<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><code>pdm<span class="w"> </span>list<span class="w"> </span>--fields<span class="w"> </span>name,license,version
+<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><code>pdm<span class="w"> </span>list<span class="w"> </span>--fields<span class="w"> </span>name,licenses,version
 </code></pre></div></td></tr></table></div>
 <p>For all supported fields, please refer to the <a href="../../reference/cli/#list_1">CLI reference</a>.</p>
 <p>Also, you can specify the output format other than the default table output. The supported formats and options are <code>--csv</code>, <code>--json</code>, <code>--markdown</code> and <code>--freeze</code>.</p>

2.11/usage/project/index.html

@@ -448,8 +448,8 @@
 </li>
 
         <li class="md-nav__item">
-  <a href="#working-with-python-37" class="md-nav__link">
-    Working with Python &lt; 3.7
+  <a href="#working-with-older-python-versions" class="md-nav__link">
+    Working with older Python versions
   </a>
 
 </li>
@@ -896,8 +896,8 @@
 </li>
 
         <li class="md-nav__item">
-  <a href="#working-with-python-37" class="md-nav__link">
-    Working with Python &lt; 3.7
+  <a href="#working-with-older-python-versions" class="md-nav__link">
+    Working with older Python versions
   </a>
 
 </li>
@@ -1003,8 +1003,8 @@ <h2 id="set-requires-python-value">Set <code>requires-python</code> value<a clas
 </tr>
 </tbody>
 </table>
-<h2 id="working-with-python-37">Working with Python &lt; 3.7<a class="headerlink" href="#working-with-python-37" title="Permanent link">#</a></h2>
-<p>Although PDM run on Python 3.7 and above, you can still have lower Python versions for your <strong>working project</strong>. But remember, if your project is a library, which needs to be built, published or installed, you make sure the PEP 517 build backend being used supports the lowest Python version you need. For instance, the default backend <code>pdm-backend</code> only works on Python 3.7+, so if you run <a href="../../reference/cli/#build"><code>pdm build</code></a> on a project with Python 3.6, you will get an error. Most modern build backends have dropped the support for Python 3.6 and lower, so it is highly recommended to upgrade the Python version to 3.7+. Here are the supported Python range for some commonly used build backends, we only list those that support PEP 621 since otherwise PDM can't work with them.</p>
+<h2 id="working-with-older-python-versions">Working with older Python versions<a class="headerlink" href="#working-with-older-python-versions" title="Permanent link">#</a></h2>
+<p>Although PDM run on Python 3.8 and above, you can still have lower Python versions for your <strong>working project</strong>. But remember, if your project is a library, which needs to be built, published or installed, you make sure the PEP 517 build backend being used supports the lowest Python version you need. For instance, the default backend <code>pdm-backend</code> only works on Python 3.7+, so if you run <a href="../../reference/cli/#build"><code>pdm build</code></a> on a project with Python 3.6, you will get an error. Most modern build backends have dropped the support for Python 3.6 and lower, so it is highly recommended to upgrade the Python version to 3.7+. Here are the supported Python range for some commonly used build backends, we only list those that support PEP 621 since otherwise PDM can't work with them.</p>
 <table>
 <thead>
 <tr>

2.11/usage/venv/index.html

@@ -1144,7 +1144,27 @@ <h2 id="activate-a-virtualenv">Activate a virtualenv<a class="headerlink" href="
 <span class="w">  </span><span class="k">fi</span>
 <span class="o">}</span>
 </code></pre></div></td></tr></table></div>
-<p>Copy and paste this function to your <code>~/.bashrc</code> file and restart your shell. Now you can run <code>pdm shell</code> to activate the virtualenv.
+<p>Copy and paste this function to your <code>~/.bashrc</code> file and restart your shell. </p>
+<p>For <code>fish</code> shell you can put the following into your <code>~/fish/config.fish</code> or in <code>~/.config/fish/config.fish</code></p>
+<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
+<span class="normal">2</span>
+<span class="normal">3</span>
+<span class="normal">4</span>
+<span class="normal">5</span>
+<span class="normal">6</span>
+<span class="normal">7</span>
+<span class="normal">8</span>
+<span class="normal">9</span></pre></div></td><td class="code"><div><pre><span></span><code>  <span class="k">function</span> pdm
+      <span class="k">set</span> cmd <span class="nv">$argv</span><span class="o">[</span>1<span class="o">]</span>
+
+      <span class="k">if</span> <span class="k">test</span> <span class="s2">&quot;</span><span class="nv">$cmd</span><span class="s2">&quot;</span> <span class="o">=</span> <span class="s2">&quot;shell&quot;</span>
+          <span class="nb">eval</span> <span class="o">(</span>pdm venv activate<span class="o">)</span>
+      <span class="k">else</span>
+          <span class="nb">command </span>pdm <span class="nv">$argv</span>
+      <span class="k">end</span>
+  <span class="k">end</span>
+</code></pre></div></td></tr></table></div>
+<p>Now you can run <code>pdm shell</code> to activate the virtualenv.
   <strong>The virtualenv can be deactivated with <code>deactivate</code> command as usual.</strong></p>
 </div>
 <h2 id="prompt-customization">Prompt customization<a class="headerlink" href="#prompt-customization" title="Permanent link">#</a></h2>