Update docs [skip ci]

.buildinfo

@@ -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: ba2586901e2fdc843ceba61cf00da0a2
+config: c1cb09409ecc2738580dc944b34f8f2c
 tags: 645f666f9bcd5a90fca523b33c5a78b7

_sources/getting_started.rst.txt

@@ -8,7 +8,7 @@ Repo file structure
 |   * `ISSUE_TEMPLATE` has files that are templates users can select from when opening an issue in the repo on GitHub
 |   * `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*.
+|        - `format_lint.yml` lints and formats the code on each push using *ruff*.
 |        - `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.
@@ -38,7 +38,7 @@ Interacting with your new code
 | 2) Run your tests:
 | `pytest .`
 | 3) Run linting and formatting to see their effects:
-| `black .` and `ruff check .`
+| `ruff check .`
 | 4) Run type checking using mypy:
 | `mypy --strict .`
 | 5) Build your docs locally:

_static/searchtools.js

@@ -178,7 +178,7 @@ const Search = {
 
   htmlToText: (htmlString, anchor) => {
     const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html');
-    for (const removalQuery of [".headerlinks", "script", "style"]) {
+    for (const removalQuery of [".headerlink", "script", "style"]) {
       htmlElement.querySelectorAll(removalQuery).forEach((el) => { el.remove() });
     }
     if (anchor) {
@@ -328,13 +328,14 @@ const Search = {
     for (const [title, foundTitles] of Object.entries(allTitles)) {
       if (title.toLowerCase().trim().includes(queryLower) && (queryLower.length >= title.length/2)) {
         for (const [file, id] of foundTitles) {
-          let score = Math.round(100 * queryLower.length / title.length)
+          const score = Math.round(Scorer.title * queryLower.length / title.length);
+          const boost = titles[file] === title ? 1 : 0;  // add a boost for document titles
           normalResults.push([
             docNames[file],
             titles[file] !== title ? `${titles[file]} > ${title}` : title,
             id !== null ? "#" + id : "",
             null,
-            score,
+            score + boost,
             filenames[file],
           ]);
         }

coverage/class_index.html

@@ -54,8 +54,8 @@ <h2>
                 <a class="button current">Classes</a>
         </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:36 +0000
+            <a class="nav" href="https://coverage.readthedocs.io/en/7.6.0">coverage.py v7.6.0</a>,
+            created at 2024-07-29 17:52 +0000
         </p>
     </div>
 </header>
@@ -83,20 +83,20 @@ <h2>
             <tr class="region">
                 <td class="name left"><a href="z_e6f4b5fa949e942d_example_module_py.html">py_template/example_module.py</a></td>
                 <td class="name left"><a href="z_e6f4b5fa949e942d_example_module_py.html"><data value=''><span class='no-noun'>(no class)</span></data></a></td>
-                <td>4</td>
+                <td>10</td>
                 <td>0</td>
                 <td>0</td>
-                <td class="right" data-ratio="4 4">100%</td>
+                <td class="right" data-ratio="10 10">100%</td>
             </tr>
         </tbody>
         <tfoot>
             <tr class="total">
                 <td class="name left">Total</td>
                 <td class="name left">&nbsp;</td>
-                <td>12</td>
+                <td>18</td>
                 <td>0</td>
                 <td>0</td>
-                <td class="right" data-ratio="12 12">100%</td>
+                <td class="right" data-ratio="18 18">100%</td>
             </tr>
         </tfoot>
     </table>
@@ -107,8 +107,8 @@ <h2>
 <footer>
     <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:36 +0000
+            <a class="nav" href="https://coverage.readthedocs.io/en/7.6.0">coverage.py v7.6.0</a>,
+            created at 2024-07-29 17:52 +0000
         </p>
     </div>
     <aside class="hidden">

coverage/function_index.html

@@ -54,8 +54,8 @@ <h2>
                 <a class="button" href="class_index.html">Classes</a>
         </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:36 +0000
+            <a class="nav" href="https://coverage.readthedocs.io/en/7.6.0">coverage.py v7.6.0</a>,
+            created at 2024-07-29 17:52 +0000
         </p>
     </div>
 </header>
@@ -123,8 +123,8 @@ <h2>
 <footer>
     <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:36 +0000
+            <a class="nav" href="https://coverage.readthedocs.io/en/7.6.0">coverage.py v7.6.0</a>,
+            created at 2024-07-29 17:52 +0000
         </p>
     </div>
     <aside class="hidden">

coverage/index.html

@@ -53,8 +53,8 @@ <h2>
                 <a class="button" href="class_index.html">Classes</a>
         </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:36 +0000
+            <a class="nav" href="https://coverage.readthedocs.io/en/7.6.0">coverage.py v7.6.0</a>,
+            created at 2024-07-29 17:52 +0000
         </p>
     </div>
 </header>
@@ -95,8 +95,8 @@ <h2>
 <footer>
     <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:36 +0000
+            <a class="nav" href="https://coverage.readthedocs.io/en/7.6.0">coverage.py v7.6.0</a>,
+            created at 2024-07-29 17:52 +0000
         </p>
     </div>
     <aside class="hidden">

coverage/status.json

@@ -1 +1 @@
-{"note":"This file is an internal implementation detail to speed up HTML report generation. Its format can change at any time. You might be looking for the JSON report: https://coverage.rtfd.io/cmd.html#cmd-json","format":5,"version":"7.5.4","globals":"359f5d75030ab979773546ed13f8761e","files":{"z_e6f4b5fa949e942d_example_module_py":{"hash":"856f7d79b396679dc7d8db18fa435158","index":{"url":"z_e6f4b5fa949e942d_example_module_py.html","file":"py_template/example_module.py","description":"","nums":{"precision":0,"n_files":1,"n_statements":18,"n_excluded":0,"n_missing":0,"n_branches":0,"n_partial_branches":0,"n_missing_branches":0}}}}}
+{"note":"This file is an internal implementation detail to speed up HTML report generation. Its format can change at any time. You might be looking for the JSON report: https://coverage.rtfd.io/cmd.html#cmd-json","format":5,"version":"7.6.0","globals":"b3a326d6d50989ae091ed43fae0180d9","files":{"z_e6f4b5fa949e942d_example_module_py":{"hash":"856f7d79b396679dc7d8db18fa435158","index":{"url":"z_e6f4b5fa949e942d_example_module_py.html","file":"py_template/example_module.py","description":"","nums":{"precision":0,"n_files":1,"n_statements":18,"n_excluded":0,"n_missing":0,"n_branches":0,"n_partial_branches":0,"n_missing_branches":0}}}}}

coverage/z_e6f4b5fa949e942d_example_module_py.html

@@ -64,8 +64,8 @@ <h2>
             <a id="indexLink" class="nav" href="index.html">&Hat; index</a> &nbsp; &nbsp;
             <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:36 +0000
+            <a class="nav" href="https://coverage.readthedocs.io/en/7.6.0">coverage.py v7.6.0</a>,
+            created at 2024-07-29 17:52 +0000
         </p>
         <aside class="hidden">
             <button type="button" class="button_next_chunk" data-shortcut="j"></button>
@@ -138,8 +138,8 @@ <h2>
             <a class="nav" href="index.html">&Hat; index</a> &nbsp; &nbsp;
             <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:36 +0000
+            <a class="nav" href="https://coverage.readthedocs.io/en/7.6.0">coverage.py v7.6.0</a>,
+            created at 2024-07-29 17:52 +0000
         </p>
     </div>
 </footer>

getting_started.html

@@ -101,7 +101,7 @@ <h2>Repo file structure<a class="headerlink" href="#repo-file-structure" title="
 <div class="line">* <code class="xref py py-obj docutils literal notranslate"><span class="pre">workflows</span></code> implements continuous integration (CI) through GitHub ‘actions’ that are automatically run according to a chosen trigger. These are currently:</div>
 <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">format_lint.yml</span></code> lints and formats the code on each push using <em>ruff</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>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>
@@ -137,7 +137,7 @@ <h2>Interacting with your new code<a class="headerlink" href="#interacting-with-
 <div class="line">2) Run your tests:</div>
 <div class="line"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pytest</span> <span class="pre">.</span></code></div>
 <div class="line">3) Run linting and formatting to see their effects:</div>
-<div class="line"><code class="xref py py-obj docutils literal notranslate"><span class="pre">black</span> <span class="pre">.</span></code> and <code class="xref py py-obj docutils literal notranslate"><span class="pre">ruff</span> <span class="pre">check</span> <span class="pre">.</span></code></div>
+<div class="line"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ruff</span> <span class="pre">check</span> <span class="pre">.</span></code></div>
 <div class="line">4) Run type checking using mypy:</div>
 <div class="line"><code class="xref py py-obj docutils literal notranslate"><span class="pre">mypy</span> <span class="pre">--strict</span> <span class="pre">.</span></code></div>
 <div class="line">5) Build your docs locally:</div>