Update docs [skip ci]

CCA-Software-Group · Jul 9, 2024 · d8f0c5b · d8f0c5b
1 parent bc251a5
commit d8f0c5b
Show file tree

Hide file tree

Showing 8 changed files with 12 additions and 14 deletions.
diff --git a/_sources/getting_started.rst.txt b/_sources/getting_started.rst.txt
@@ -20,7 +20,6 @@ Repo file structure
 | 8) `MANIFEST.in` has instructions for how to pre-process the package (which files to exclude) when preparing to release it to PyPI (the Python Package Index). Packages uploaded to PyPI can be installed by users with *pip*. 
 | 9) `README.md` is the file you're reading! It has badges that use the CI to display if the unit tests are passing, what percentage of the code is covered by the tests, and if the docs build and deploy is passing.
 | 10) `pyproject.toml` is the configuration file for the entire package. See the `Python docs <https://packaging.python.org/en/latest/guides/writing-pyproject-toml/>`_ for a description of its contents.
-| 11) `tox.ini` is a configuration file used to set up testing. See the `tox docs <https://tox.wiki/en/latest/index.html>`_ for a description of its contents.
 
 Making a new Python repo using `py_template`
 --------------------------------------------
@@ -42,7 +41,7 @@ Interacting with your new code
 | 4) Run type checking using mypy:
 | `mypy --strict .`
 | 5) Build your docs locally:
-| `tox -e build_docs` or `cd docs; make html` 
+| `cd docs; make html`
 | After building the docs, view them with 
 | `open docs/_build/html/index.html`
 

diff --git a/coverage/class_index.html b/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-09 18:41 +0000
+            created at 2024-07-09 18:51 +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-09 18:41 +0000
+            created at 2024-07-09 18:51 +0000
         </p>
     </div>
     <aside class="hidden">

diff --git a/coverage/function_index.html b/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-09 18:41 +0000
+            created at 2024-07-09 18:51 +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-09 18:41 +0000
+            created at 2024-07-09 18:51 +0000
         </p>
     </div>
     <aside class="hidden">

diff --git a/coverage/index.html b/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-09 18:41 +0000
+            created at 2024-07-09 18:51 +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-09 18:41 +0000
+            created at 2024-07-09 18:51 +0000
         </p>
     </div>
     <aside class="hidden">

diff --git a/coverage/status.json b/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":"6c89ab4e6fe2cbd8838a9bec63247e04","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.5.4","globals":"5829411e02e8baa15ba2f582109b0b42","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}}}}}
diff --git a/coverage/z_e6f4b5fa949e942d_example_module_py.html b/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-09 18:41 +0000
+            created at 2024-07-09 18:51 +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-09 18:41 +0000
+            created at 2024-07-09 18:51 +0000
         </p>
     </div>
 </footer>

diff --git a/getting_started.html b/getting_started.html
@@ -115,7 +115,6 @@ <h2>Repo file structure<a class="headerlink" href="#repo-file-structure" title="
 <div class="line">8) <code class="xref py py-obj docutils literal notranslate"><span class="pre">MANIFEST.in</span></code> has instructions for how to pre-process the package (which files to exclude) when preparing to release it to PyPI (the Python Package Index). Packages uploaded to PyPI can be installed by users with <em>pip</em>.</div>
 <div class="line">9) <code class="xref py py-obj docutils literal notranslate"><span class="pre">README.md</span></code> is the file you’re reading! It has badges that use the CI to display if the unit tests are passing, what percentage of the code is covered by the tests, and if the docs build and deploy is passing.</div>
 <div class="line">10) <code class="xref py py-obj docutils literal notranslate"><span class="pre">pyproject.toml</span></code> is the configuration file for the entire package. See the <a class="reference external" href="https://packaging.python.org/en/latest/guides/writing-pyproject-toml/">Python docs</a> for a description of its contents.</div>
-<div class="line">11) <code class="xref py py-obj docutils literal notranslate"><span class="pre">tox.ini</span></code> is a configuration file used to set up testing. See the <a class="reference external" href="https://tox.wiki/en/latest/index.html">tox docs</a> for a description of its contents.</div>
 </div>
 </section>
 <section id="making-a-new-python-repo-using-py-template">
@@ -141,7 +140,7 @@ <h2>Interacting with your new code<a class="headerlink" href="#interacting-with-
 <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>
-<div class="line"><code class="xref py py-obj docutils literal notranslate"><span class="pre">tox</span> <span class="pre">-e</span> <span class="pre">build_docs</span></code> or <code class="xref py py-obj docutils literal notranslate"><span class="pre">cd</span> <span class="pre">docs;</span> <span class="pre">make</span> <span class="pre">html</span></code></div>
+<div class="line"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cd</span> <span class="pre">docs;</span> <span class="pre">make</span> <span class="pre">html</span></code></div>
 <div class="line">After building the docs, view them with</div>
 <div class="line"><code class="xref py py-obj docutils literal notranslate"><span class="pre">open</span> <span class="pre">docs/_build/html/index.html</span></code></div>
 </div>

diff --git a/searchindex.js b/searchindex.js
Original file line number	Diff line number	Diff line change
		@@ -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":"6c89ab4e6fe2cbd8838a9bec63247e04","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.5.4","globals":"5829411e02e8baa15ba2f582109b0b42","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}}}}}