Update docs [skip ci]

_sources/getting_started.rst.txt

@@ -9,7 +9,7 @@ Repo file structure
 |   * `workflows` implements continuous integration (CI) through GitHub 'actions' that are automatically run according to a chosen trigger. These are currently:
 |        - `docs.yml` builds and deploys this docs site when a push is made to `main`.
 |        - `format_lint.yml` lints and formats the code on each push using *ruff* and *black*.
-|        - `package.yml` releases the package to PyPI on each *tagged* push to `main`. This makes the latest tagged version of the package `pip`-installable.
+|        - `package.yml` releases the package to PyPI on each *release* (create a release from the repo's main GitHub page). This makes the latest release version of the package *pip*-installable. For a guide on how to first reserve a name for your project on PyPI (necessary for this workflow), see the `Python packaging guide <https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/>`_.
 |        - `tests.yml` runs tests with *pytest* on each push.
 |        - `type_check.yml` runs type checking with *mypy* on each push. The CI continues even if the type checker finds errors.
 | 2) `docs` has the files used to build the docs with *Sphinx*, with the site content in `index.rst` and `py_API.rst`.

coverage/class_index.html

@@ -55,7 +55,7 @@ <h2>
         </h2>
         <p class="text">
             <a class="nav" href="https://coverage.readthedocs.io/en/7.5.4">coverage.py v7.5.4</a>,
-            created at 2024-07-10 16:25 +0000
+            created at 2024-07-10 16:36 +0000
         </p>
     </div>
 </header>
@@ -108,7 +108,7 @@ <h2>
     <div class="content">
         <p>
             <a class="nav" href="https://coverage.readthedocs.io/en/7.5.4">coverage.py v7.5.4</a>,
-            created at 2024-07-10 16:25 +0000
+            created at 2024-07-10 16:36 +0000
         </p>
     </div>
     <aside class="hidden">

coverage/function_index.html

@@ -55,7 +55,7 @@ <h2>
         </h2>
         <p class="text">
             <a class="nav" href="https://coverage.readthedocs.io/en/7.5.4">coverage.py v7.5.4</a>,
-            created at 2024-07-10 16:25 +0000
+            created at 2024-07-10 16:36 +0000
         </p>
     </div>
 </header>
@@ -124,7 +124,7 @@ <h2>
     <div class="content">
         <p>
             <a class="nav" href="https://coverage.readthedocs.io/en/7.5.4">coverage.py v7.5.4</a>,
-            created at 2024-07-10 16:25 +0000
+            created at 2024-07-10 16:36 +0000
         </p>
     </div>
     <aside class="hidden">

coverage/index.html

@@ -54,7 +54,7 @@ <h2>
         </h2>
         <p class="text">
             <a class="nav" href="https://coverage.readthedocs.io/en/7.5.4">coverage.py v7.5.4</a>,
-            created at 2024-07-10 16:25 +0000
+            created at 2024-07-10 16:36 +0000
         </p>
     </div>
 </header>
@@ -96,7 +96,7 @@ <h2>
     <div class="content">
         <p>
             <a class="nav" href="https://coverage.readthedocs.io/en/7.5.4">coverage.py v7.5.4</a>,
-            created at 2024-07-10 16:25 +0000
+            created at 2024-07-10 16:36 +0000
         </p>
     </div>
     <aside class="hidden">

coverage/z_e6f4b5fa949e942d_example_module_py.html

@@ -65,7 +65,7 @@ <h2>
             <a id="nextFileLink" class="nav" href="index.html">&#xbb; next</a>
             &nbsp; &nbsp; &nbsp;
             <a class="nav" href="https://coverage.readthedocs.io/en/7.5.4">coverage.py v7.5.4</a>,
-            created at 2024-07-10 16:25 +0000
+            created at 2024-07-10 16:36 +0000
         </p>
         <aside class="hidden">
             <button type="button" class="button_next_chunk" data-shortcut="j"></button>
@@ -139,7 +139,7 @@ <h2>
             <a class="nav" href="index.html">&#xbb; next</a>
             &nbsp; &nbsp; &nbsp;
             <a class="nav" href="https://coverage.readthedocs.io/en/7.5.4">coverage.py v7.5.4</a>,
-            created at 2024-07-10 16:25 +0000
+            created at 2024-07-10 16:36 +0000
         </p>
     </div>
 </footer>

getting_started.html

@@ -102,7 +102,7 @@ <h2>Repo file structure<a class="headerlink" href="#repo-file-structure" title="
 <div class="line-block">
 <div class="line">- <code class="xref py py-obj docutils literal notranslate"><span class="pre">docs.yml</span></code> builds and deploys this docs site when a push is made to <code class="xref py py-obj docutils literal notranslate"><span class="pre">main</span></code>.</div>
 <div class="line">- <code class="xref py py-obj docutils literal notranslate"><span class="pre">format_lint.yml</span></code> lints and formats the code on each push using <em>ruff</em> and <em>black</em>.</div>
-<div class="line">- <code class="xref py py-obj docutils literal notranslate"><span class="pre">package.yml</span></code> releases the package to PyPI on each <em>tagged</em> push to <code class="xref py py-obj docutils literal notranslate"><span class="pre">main</span></code>. This makes the latest tagged version of the package <code class="xref py py-obj docutils literal notranslate"><span class="pre">pip</span></code>-installable.</div>
+<div class="line">- <code class="xref py py-obj docutils literal notranslate"><span class="pre">package.yml</span></code> releases the package to PyPI on each <em>release</em> (create a release from the repo’s main GitHub page). This makes the latest release version of the package <em>pip</em>-installable. For a guide on how to first reserve a name for your project on PyPI (necessary for this workflow), see the <a class="reference external" href="https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/">Python packaging guide</a>.</div>
 <div class="line">- <code class="xref py py-obj docutils literal notranslate"><span class="pre">tests.yml</span></code> runs tests with <em>pytest</em> on each push.</div>
 <div class="line">- <code class="xref py py-obj docutils literal notranslate"><span class="pre">type_check.yml</span></code> runs type checking with <em>mypy</em> on each push. The CI continues even if the type checker finds errors.</div>
 </div>