Deployed 8927e2f with MkDocs version: 1.2.3

Author: pawamoy

changelog/index.html

@@ -981,17 +981,16 @@ <h2 id="development">Development<a class="headerlink" href="#development" title=
 <li>create a new branch: <code>git checkout -b feature-or-bugfix-name</code></li>
 <li>edit the code and/or the documentation</li>
 </ol>
-<p>If you updated the documentation or the project dependencies:</p>
-<ol>
-<li>run <code>make docs-regen</code></li>
-<li>run <code>make docs-serve</code>,
-   go to <a href="http://localhost:8000">http://localhost:8000</a> and check that everything looks good</li>
-</ol>
 <p><strong>Before committing:</strong></p>
 <ol>
 <li>run <code>make format</code> to auto-format the code</li>
 <li>run <code>make check</code> to check everything (fix any warning)</li>
 <li>run <code>make test</code> to run the tests (fix any issue)</li>
+<li>if you updated the documentation or the project dependencies:<ol>
+<li>run <code>make docs-serve</code></li>
+<li>go to <a href="http://localhost:8000">http://localhost:8000</a> and check that everything looks good</li>
+</ol>
+</li>
 <li>follow our <a href="#commit-message-convention">commit message convention</a></li>
 </ol>
 <p>If you are unsure about how to fix or ignore a warning,

contributing/index.html

@@ -11,7 +11,7 @@
 <header>
     <div class="content">
         <h1>Coverage report:
-            <span class="pc_cov">95.12%</span>
+            <span class="pc_cov">95.04%</span>
         </h1>
         <div id="help_panel_wrapper">
             <input id="help_panel_state" type="checkbox">
@@ -117,12 +117,12 @@ <h1>Coverage report:
             </tr>
             <tr class="file">
                 <td class="name left"><a href="d_d9e03bf1e1fb8158_numpy_py.html">src/pytkdocs/parsers/docstrings/numpy.py</a></td>
-                <td>135</td>
-                <td>10</td>
+                <td>145</td>
+                <td>13</td>
                 <td>0</td>
-                <td>84</td>
+                <td>90</td>
                 <td>13</td>
-                <td class="right" data-ratio="196 219">89.50%</td>
+                <td class="right" data-ratio="207 235">88.09%</td>
             </tr>
             <tr class="file">
                 <td class="name left"><a href="d_d9e03bf1e1fb8158_restructured_text_py.html">src/pytkdocs/parsers/docstrings/restructured_text.py</a></td>
@@ -234,12 +234,12 @@ <h1>Coverage report:
             </tr>
             <tr class="file">
                 <td class="name left"><a href="d_ccd6818ca7bebb6d_test_numpy_py.html">tests/test_parsers/test_docstrings/test_numpy.py</a></td>
-                <td>146</td>
+                <td>163</td>
                 <td>12</td>
                 <td>0</td>
-                <td>6</td>
+                <td>12</td>
                 <td>0</td>
-                <td class="right" data-ratio="140 152">92.11%</td>
+                <td class="right" data-ratio="163 175">93.14%</td>
             </tr>
             <tr class="file">
                 <td class="name left"><a href="d_ccd6818ca7bebb6d_test_restructured_text_py.html">tests/test_parsers/test_docstrings/test_restructured_text.py</a></td>
@@ -272,12 +272,12 @@ <h1>Coverage report:
         <tfoot>
             <tr class="total">
                 <td class="name left">Total</td>
-                <td>2985</td>
-                <td>115</td>
+                <td>3012</td>
+                <td>118</td>
                 <td>0</td>
-                <td>848</td>
+                <td>860</td>
                 <td>66</td>
-                <td class="right" data-ratio="3646 3833">95.12%</td>
+                <td class="right" data-ratio="3680 3872">95.04%</td>
             </tr>
         </tfoot>
     </table>
@@ -289,7 +289,7 @@ <h1>Coverage report:
     <div class="content">
         <p>
             <a class="nav" href="https://coverage.readthedocs.io">coverage.py v6.3.1</a>,
-            created at 2022-02-19 18:37 +0100
+            created at 2022-03-07 19:47 +0100
         </p>
     </div>
 </footer>

coverage/covindex.html

@@ -1 +1 @@
-{"format":2,"version":"6.3.1","globals":"78d057b27086733ce89636b5435d6042","files":{"d_2747c01e5320e4c7_cli_py":{"hash":"524b29c3ff90bf14570b5e691f608dd5","index":{"nums":[2,1,64,0,2,16,2,2],"html_filename":"d_2747c01e5320e4c7_cli_py.html","relative_filename":"src/pytkdocs/cli.py"}},"d_2747c01e5320e4c7_loader_py":{"hash":"dfdf6456eb85ba033e2e2e375698fd9b","index":{"nums":[2,1,407,0,22,176,16,16],"html_filename":"d_2747c01e5320e4c7_loader_py.html","relative_filename":"src/pytkdocs/loader.py"}},"d_2747c01e5320e4c7_objects_py":{"hash":"aca62a980ecaa1ac3d5ef6e64e719769","index":{"nums":[2,1,164,0,2,52,2,2],"html_filename":"d_2747c01e5320e4c7_objects_py.html","relative_filename":"src/pytkdocs/objects.py"}},"d_f735a248890dbd46_attributes_py":{"hash":"8a8252dc11a12f93a82ea72eec13944c","index":{"nums":[2,1,112,0,4,62,3,3],"html_filename":"d_f735a248890dbd46_attributes_py.html","relative_filename":"src/pytkdocs/parsers/attributes.py"}},"d_d9e03bf1e1fb8158_base_py":{"hash":"2d81c5a51fc210da5c4aca1f6614c2e9","index":{"nums":[2,1,88,0,12,24,1,3],"html_filename":"d_d9e03bf1e1fb8158_base_py.html","relative_filename":"src/pytkdocs/parsers/docstrings/base.py"}},"d_d9e03bf1e1fb8158_google_py":{"hash":"99244c090819d8a82e40fe25fcf75d97","index":{"nums":[2,1,264,0,16,128,14,14],"html_filename":"d_d9e03bf1e1fb8158_google_py.html","relative_filename":"src/pytkdocs/parsers/docstrings/google.py"}},"d_d9e03bf1e1fb8158_markdown_py":{"hash":"ba54e520c6babf7b6f6d7afdbf0e9b3d","index":{"nums":[2,1,5,0,1,2,0,0],"html_filename":"d_d9e03bf1e1fb8158_markdown_py.html","relative_filename":"src/pytkdocs/parsers/docstrings/markdown.py"}},"d_d9e03bf1e1fb8158_numpy_py":{"hash":"66dc625b1bc74602070008cb4bc3586c","index":{"nums":[2,1,135,0,10,84,13,13],"html_filename":"d_d9e03bf1e1fb8158_numpy_py.html","relative_filename":"src/pytkdocs/parsers/docstrings/numpy.py"}},"d_d9e03bf1e1fb8158_restructured_text_py":{"hash":"ce7a472d332dcff03938bca1442fa022","index":{"nums":[2,1,264,0,0,116,0,0],"html_filename":"d_d9e03bf1e1fb8158_restructured_text_py.html","relative_filename":"src/pytkdocs/parsers/docstrings/restructured_text.py"}},"d_2747c01e5320e4c7_properties_py":{"hash":"3dd43da32a0494ee6aa7cfeeca31676c","index":{"nums":[2,1,15,0,0,6,0,0],"html_filename":"d_2747c01e5320e4c7_properties_py.html","relative_filename":"src/pytkdocs/properties.py"}},"d_2747c01e5320e4c7_serializer_py":{"hash":"0da98703dab7693d76542dcc3fcd4f5e","index":{"nums":[2,1,87,0,4,60,3,7],"html_filename":"d_2747c01e5320e4c7_serializer_py.html","relative_filename":"src/pytkdocs/serializer.py"}},"d_a44f0ac069e85531_conftest_py":{"hash":"65478c9a360455166c1c8c4e2b1d8444","index":{"nums":[2,1,0,0,0,0,0,0],"html_filename":"d_a44f0ac069e85531_conftest_py.html","relative_filename":"tests/conftest.py"}},"d_a44f0ac069e85531_test_cli_py":{"hash":"f1b5ba64161e597af9f8223b30a3461b","index":{"nums":[2,1,34,0,0,4,0,0],"html_filename":"d_a44f0ac069e85531_test_cli_py.html","relative_filename":"tests/test_cli.py"}},"d_a44f0ac069e85531_test_loader_py":{"hash":"b6b8b6393c34b59243b3a0efa497c31a","index":{"nums":[2,1,326,0,0,62,12,12],"html_filename":"d_a44f0ac069e85531_test_loader_py.html","relative_filename":"tests/test_loader.py"}},"d_a44f0ac069e85531_test_objects_py":{"hash":"881d44f7db3bc03e72a0907c6e21413a","index":{"nums":[2,1,74,0,0,0,0,0],"html_filename":"d_a44f0ac069e85531_test_objects_py.html","relative_filename":"tests/test_objects.py"}},"d_57093e5aa6fa0ef1___init___py":{"hash":"ee8164c97c3c831d4632bc6bde22fd80","index":{"nums":[2,1,0,0,0,0,0,0],"html_filename":"d_57093e5aa6fa0ef1___init___py.html","relative_filename":"tests/test_parsers/__init__.py"}},"d_57093e5aa6fa0ef1_test_annotations_py":{"hash":"5a0389f116944ab9f8fbb30388235e08","index":{"nums":[2,1,13,0,0,4,0,0],"html_filename":"d_57093e5aa6fa0ef1_test_annotations_py.html","relative_filename":"tests/test_parsers/test_annotations.py"}},"d_57093e5aa6fa0ef1_test_attributes_py":{"hash":"4b453bae1ac47b0b534487823fdad039","index":{"nums":[2,1,86,0,0,12,0,0],"html_filename":"d_57093e5aa6fa0ef1_test_attributes_py.html","relative_filename":"tests/test_parsers/test_attributes.py"}},"d_ccd6818ca7bebb6d___init___py":{"hash":"850f66b58ef616fc5eccadb9d6f31946","index":{"nums":[2,1,0,0,0,0,0,0],"html_filename":"d_ccd6818ca7bebb6d___init___py.html","relative_filename":"tests/test_parsers/test_docstrings/__init__.py"}},"d_ccd6818ca7bebb6d_test_google_py":{"hash":"115839bc92c970d8b3d02d2ee36bbc6c","index":{"nums":[2,1,304,0,19,16,0,0],"html_filename":"d_ccd6818ca7bebb6d_test_google_py.html","relative_filename":"tests/test_parsers/test_docstrings/test_google.py"}},"d_ccd6818ca7bebb6d_test_numpy_py":{"hash":"2430e5ecd2c858f250edd2844f485e26","index":{"nums":[2,1,146,0,12,6,0,0],"html_filename":"d_ccd6818ca7bebb6d_test_numpy_py.html","relative_filename":"tests/test_parsers/test_docstrings/test_numpy.py"}},"d_ccd6818ca7bebb6d_test_restructured_text_py":{"hash":"4a26273ffcd1eb264ba12cb6fb6854f2","index":{"nums":[2,1,371,0,11,18,0,0],"html_filename":"d_ccd6818ca7bebb6d_test_restructured_text_py.html","relative_filename":"tests/test_parsers/test_docstrings/test_restructured_text.py"}},"d_a44f0ac069e85531_test_properties_py":{"hash":"86b49dfe101b7a71204df5f887d4745a","index":{"nums":[2,1,26,0,0,0,0,0],"html_filename":"d_a44f0ac069e85531_test_properties_py.html","relative_filename":"tests/test_properties.py"}},"d_a44f0ac069e85531_test_serializer_py":{"hash":"3fdc9df8892de4306147fba89586e5bd","index":{"nums":[2,1,0,0,0,0,0,0],"html_filename":"d_a44f0ac069e85531_test_serializer_py.html","relative_filename":"tests/test_serializer.py"}}}}
+{"format":2,"version":"6.3.1","globals":"78d057b27086733ce89636b5435d6042","files":{"d_2747c01e5320e4c7_cli_py":{"hash":"524b29c3ff90bf14570b5e691f608dd5","index":{"nums":[2,1,64,0,2,16,2,2],"html_filename":"d_2747c01e5320e4c7_cli_py.html","relative_filename":"src/pytkdocs/cli.py"}},"d_2747c01e5320e4c7_loader_py":{"hash":"dfdf6456eb85ba033e2e2e375698fd9b","index":{"nums":[2,1,407,0,22,176,16,16],"html_filename":"d_2747c01e5320e4c7_loader_py.html","relative_filename":"src/pytkdocs/loader.py"}},"d_2747c01e5320e4c7_objects_py":{"hash":"aca62a980ecaa1ac3d5ef6e64e719769","index":{"nums":[2,1,164,0,2,52,2,2],"html_filename":"d_2747c01e5320e4c7_objects_py.html","relative_filename":"src/pytkdocs/objects.py"}},"d_f735a248890dbd46_attributes_py":{"hash":"8a8252dc11a12f93a82ea72eec13944c","index":{"nums":[2,1,112,0,4,62,3,3],"html_filename":"d_f735a248890dbd46_attributes_py.html","relative_filename":"src/pytkdocs/parsers/attributes.py"}},"d_d9e03bf1e1fb8158_base_py":{"hash":"2d81c5a51fc210da5c4aca1f6614c2e9","index":{"nums":[2,1,88,0,12,24,1,3],"html_filename":"d_d9e03bf1e1fb8158_base_py.html","relative_filename":"src/pytkdocs/parsers/docstrings/base.py"}},"d_d9e03bf1e1fb8158_google_py":{"hash":"99244c090819d8a82e40fe25fcf75d97","index":{"nums":[2,1,264,0,16,128,14,14],"html_filename":"d_d9e03bf1e1fb8158_google_py.html","relative_filename":"src/pytkdocs/parsers/docstrings/google.py"}},"d_d9e03bf1e1fb8158_markdown_py":{"hash":"ba54e520c6babf7b6f6d7afdbf0e9b3d","index":{"nums":[2,1,5,0,1,2,0,0],"html_filename":"d_d9e03bf1e1fb8158_markdown_py.html","relative_filename":"src/pytkdocs/parsers/docstrings/markdown.py"}},"d_d9e03bf1e1fb8158_numpy_py":{"hash":"620cba1878fb6afe5c8633d37fe4869d","index":{"nums":[2,1,145,0,13,90,13,15],"html_filename":"d_d9e03bf1e1fb8158_numpy_py.html","relative_filename":"src/pytkdocs/parsers/docstrings/numpy.py"}},"d_d9e03bf1e1fb8158_restructured_text_py":{"hash":"ce7a472d332dcff03938bca1442fa022","index":{"nums":[2,1,264,0,0,116,0,0],"html_filename":"d_d9e03bf1e1fb8158_restructured_text_py.html","relative_filename":"src/pytkdocs/parsers/docstrings/restructured_text.py"}},"d_2747c01e5320e4c7_properties_py":{"hash":"3dd43da32a0494ee6aa7cfeeca31676c","index":{"nums":[2,1,15,0,0,6,0,0],"html_filename":"d_2747c01e5320e4c7_properties_py.html","relative_filename":"src/pytkdocs/properties.py"}},"d_2747c01e5320e4c7_serializer_py":{"hash":"0da98703dab7693d76542dcc3fcd4f5e","index":{"nums":[2,1,87,0,4,60,3,7],"html_filename":"d_2747c01e5320e4c7_serializer_py.html","relative_filename":"src/pytkdocs/serializer.py"}},"d_a44f0ac069e85531_conftest_py":{"hash":"65478c9a360455166c1c8c4e2b1d8444","index":{"nums":[2,1,0,0,0,0,0,0],"html_filename":"d_a44f0ac069e85531_conftest_py.html","relative_filename":"tests/conftest.py"}},"d_a44f0ac069e85531_test_cli_py":{"hash":"f1b5ba64161e597af9f8223b30a3461b","index":{"nums":[2,1,34,0,0,4,0,0],"html_filename":"d_a44f0ac069e85531_test_cli_py.html","relative_filename":"tests/test_cli.py"}},"d_a44f0ac069e85531_test_loader_py":{"hash":"b6b8b6393c34b59243b3a0efa497c31a","index":{"nums":[2,1,326,0,0,62,12,12],"html_filename":"d_a44f0ac069e85531_test_loader_py.html","relative_filename":"tests/test_loader.py"}},"d_a44f0ac069e85531_test_objects_py":{"hash":"881d44f7db3bc03e72a0907c6e21413a","index":{"nums":[2,1,74,0,0,0,0,0],"html_filename":"d_a44f0ac069e85531_test_objects_py.html","relative_filename":"tests/test_objects.py"}},"d_57093e5aa6fa0ef1___init___py":{"hash":"ee8164c97c3c831d4632bc6bde22fd80","index":{"nums":[2,1,0,0,0,0,0,0],"html_filename":"d_57093e5aa6fa0ef1___init___py.html","relative_filename":"tests/test_parsers/__init__.py"}},"d_57093e5aa6fa0ef1_test_annotations_py":{"hash":"5a0389f116944ab9f8fbb30388235e08","index":{"nums":[2,1,13,0,0,4,0,0],"html_filename":"d_57093e5aa6fa0ef1_test_annotations_py.html","relative_filename":"tests/test_parsers/test_annotations.py"}},"d_57093e5aa6fa0ef1_test_attributes_py":{"hash":"4b453bae1ac47b0b534487823fdad039","index":{"nums":[2,1,86,0,0,12,0,0],"html_filename":"d_57093e5aa6fa0ef1_test_attributes_py.html","relative_filename":"tests/test_parsers/test_attributes.py"}},"d_ccd6818ca7bebb6d___init___py":{"hash":"850f66b58ef616fc5eccadb9d6f31946","index":{"nums":[2,1,0,0,0,0,0,0],"html_filename":"d_ccd6818ca7bebb6d___init___py.html","relative_filename":"tests/test_parsers/test_docstrings/__init__.py"}},"d_ccd6818ca7bebb6d_test_google_py":{"hash":"115839bc92c970d8b3d02d2ee36bbc6c","index":{"nums":[2,1,304,0,19,16,0,0],"html_filename":"d_ccd6818ca7bebb6d_test_google_py.html","relative_filename":"tests/test_parsers/test_docstrings/test_google.py"}},"d_ccd6818ca7bebb6d_test_numpy_py":{"hash":"fd87ae0c0ac401932fc63e525f4cd8d0","index":{"nums":[2,1,163,0,12,12,0,0],"html_filename":"d_ccd6818ca7bebb6d_test_numpy_py.html","relative_filename":"tests/test_parsers/test_docstrings/test_numpy.py"}},"d_ccd6818ca7bebb6d_test_restructured_text_py":{"hash":"4a26273ffcd1eb264ba12cb6fb6854f2","index":{"nums":[2,1,371,0,11,18,0,0],"html_filename":"d_ccd6818ca7bebb6d_test_restructured_text_py.html","relative_filename":"tests/test_parsers/test_docstrings/test_restructured_text.py"}},"d_a44f0ac069e85531_test_properties_py":{"hash":"86b49dfe101b7a71204df5f887d4745a","index":{"nums":[2,1,26,0,0,0,0,0],"html_filename":"d_a44f0ac069e85531_test_properties_py.html","relative_filename":"tests/test_properties.py"}},"d_a44f0ac069e85531_test_serializer_py":{"hash":"3fdc9df8892de4306147fba89586e5bd","index":{"nums":[2,1,0,0,0,0,0,0],"html_filename":"d_a44f0ac069e85531_test_serializer_py.html","relative_filename":"tests/test_serializer.py"}}}}

coverage/d_ccd6818ca7bebb6d_test_numpy_py.html

@@ -371,13 +371,6 @@
     </label>
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 
-        <li class="md-nav__item">
-  <a href="#requirements" class="md-nav__link">
-    Requirements
-  </a>
-  
-</li>
-      
         <li class="md-nav__item">
   <a href="#installation" class="md-nav__link">
     Installation
@@ -898,13 +891,6 @@
     </label>
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 
-        <li class="md-nav__item">
-  <a href="#requirements" class="md-nav__link">
-    Requirements
-  </a>
-  
-</li>
-      
         <li class="md-nav__item">
   <a href="#installation" class="md-nav__link">
     Installation
@@ -972,27 +958,6 @@ <h1 id="pytkdocs">pytkdocs<a class="headerlink" href="#pytkdocs" title="Permanen
 <a href="https://gitpod.io/#https://github.com/pawamoy/pytkdocs"><img alt="gitpod" src="https://img.shields.io/badge/gitpod-workspace-blue.svg?style=flat" /></a>
 <a href="https://gitter.im/pytkdocs/community"><img alt="gitter" src="https://badges.gitter.im/join%20chat.svg" /></a></p>
 <p>Load Python objects documentation.</p>
-<h2 id="requirements">Requirements<a class="headerlink" href="#requirements" title="Permanent link">¤</a></h2>
-<p>pytkdocs requires Python 3.7 or above.</p>
-<details>
-<summary>To install Python 3.7, I recommend using <a href="https://github.com/pyenv/pyenv"><code>pyenv</code></a>.</summary>
-
-<div class="highlight"><pre><span></span><code><span class="c1"># install pyenv</span>
-git clone https://github.com/pyenv/pyenv ~/.pyenv
-
-<span class="c1"># setup pyenv (you should also put these three lines in .bashrc or similar)</span>
-<span class="nb">export</span> <span class="nv">PATH</span><span class="o">=</span><span class="s2">&quot;</span><span class="si">${</span><span class="nv">HOME</span><span class="si">}</span><span class="s2">/.pyenv/bin:</span><span class="si">${</span><span class="nv">PATH</span><span class="si">}</span><span class="s2">&quot;</span>
-<span class="nb">export</span> <span class="nv">PYENV_ROOT</span><span class="o">=</span><span class="s2">&quot;</span><span class="si">${</span><span class="nv">HOME</span><span class="si">}</span><span class="s2">/.pyenv&quot;</span>
-<span class="nb">eval</span> <span class="s2">&quot;</span><span class="k">$(</span>pyenv init -<span class="k">)</span><span class="s2">&quot;</span>
-
-<span class="c1"># install Python 3.7</span>
-pyenv install <span class="m">3</span>.7.12
-
-<span class="c1"># make it available globally</span>
-pyenv global system <span class="m">3</span>.7.12
-</code></pre></div>
-</details>
-
 <h2 id="installation">Installation<a class="headerlink" href="#installation" title="Permanent link">¤</a></h2>
 <p>With <code>pip</code>:
 <div class="highlight"><pre><span></span><code>pip install pytkdocs

coverage/d_d9e03bf1e1fb8158_numpy_py.html

@@ -1513,7 +1513,7 @@ <h2 id="pytkdocs.cli.process_json" class="doc doc-heading">
     <div class="doc doc-contents ">
 
       <p>Process JSON input.</p>
-<p>Simply load the JSON as a Python dictionary, then pass it to <a href="#pytkdocs.cli.process_config"><code>process_config</code></a>.</p>
+<p>Simply load the JSON as a Python dictionary, then pass it to <a class="" href="#pytkdocs.cli.process_config"><code>process_config</code></a>.</p>
 
 <p><strong>Parameters:</strong></p>
 <table>
@@ -1545,7 +1545,7 @@ <h2 id="pytkdocs.cli.process_json" class="doc doc-heading">
   <tbody>
     <tr>
       <td><code>dict</code></td>
-      <td><p>The result of the call to <a href="#pytkdocs.cli.process_config"><code>process_config</code></a>.</p></td>
+      <td><p>The result of the call to <a class="" href="#pytkdocs.cli.process_config"><code>process_config</code></a>.</p></td>
     </tr>
   </tbody>
 </table>