Skip to content

Commit

Permalink
Deployed e305e4d with MkDocs version: 1.5.3
Browse files Browse the repository at this point in the history
  • Loading branch information
@github-actions
github-actions[bot] committed Nov 16, 2023
1 parent 8c1cefb commit 5c25df8
Show file tree
Hide file tree
Showing 4 changed files with 246 additions and 76 deletions.
81 changes: 35 additions & 46 deletions contributing/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -537,11 +537,6 @@ <h3 id="hatch-cheat-sheet">Hatch Cheat Sheet<a class="headerlink" href="#hatch-c
</thead>
<tbody>
<tr>
<td>Run Tests</td>
<td><code>hatch run cov</code></td>
<td>Runs tests with <code>pytest</code> and <code>coverage</code></td>
</tr>
<tr>
<td>Run Formatting</td>
<td><code>hatch run lint:fmt</code></td>
<td>Runs <code>ruff</code> code formatter</td>
Expand Down Expand Up @@ -592,38 +587,35 @@ <h3 id="hatch-explanation">Hatch Explanation<a class="headerlink" href="#hatch-e
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a> Standalone
<a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a>┏━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┓
<a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a>┃ Name ┃ Type ┃ Dependencies ┃ Scripts ┃
<a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a>┡━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━┩
<a id="__codelineno-1-5" name="__codelineno-1-5" href="#__codelineno-1-5"></a>│ default │ pip-compile │ coverage[toml]&gt;=6.5 │ cov │
<a id="__codelineno-1-6" name="__codelineno-1-6" href="#__codelineno-1-6"></a>│ │ │ pytest │ cov-report │
<a id="__codelineno-1-7" name="__codelineno-1-7" href="#__codelineno-1-7"></a>│ │ │ │ test │
<a id="__codelineno-1-8" name="__codelineno-1-8" href="#__codelineno-1-8"></a>│ │ │ │ test-cov │
<a id="__codelineno-1-9" name="__codelineno-1-9" href="#__codelineno-1-9"></a>├─────────┼─────────────┼────────────────────────────┼────────────┤
<a id="__codelineno-1-10" name="__codelineno-1-10" href="#__codelineno-1-10"></a>│ docs │ virtual │ markdown-exec[ansi]~=1.6.0 │ build │
<a id="__codelineno-1-11" name="__codelineno-1-11" href="#__codelineno-1-11"></a>│ │ │ mkdocs-material~=9.2.3 │ deploy │
<a id="__codelineno-1-12" name="__codelineno-1-12" href="#__codelineno-1-12"></a>│ │ │ mkdocstrings~=0.22.0 │ serve │
<a id="__codelineno-1-13" name="__codelineno-1-13" href="#__codelineno-1-13"></a>│ │ │ mkdocs~=1.5.2 │ │
<a id="__codelineno-1-14" name="__codelineno-1-14" href="#__codelineno-1-14"></a>├─────────┼─────────────┼────────────────────────────┼────────────┤
<a id="__codelineno-1-15" name="__codelineno-1-15" href="#__codelineno-1-15"></a>│ gen │ virtual │ │ release │
<a id="__codelineno-1-16" name="__codelineno-1-16" href="#__codelineno-1-16"></a>├─────────┼─────────────┼────────────────────────────┼────────────┤
<a id="__codelineno-1-17" name="__codelineno-1-17" href="#__codelineno-1-17"></a>│ lint │ virtual │ mypy&gt;=1.6.1 │ all │
<a id="__codelineno-1-18" name="__codelineno-1-18" href="#__codelineno-1-18"></a>│ │ │ ruff~=0.1.4 │ fmt │
<a id="__codelineno-1-19" name="__codelineno-1-19" href="#__codelineno-1-19"></a>│ │ │ │ precommit │
<a id="__codelineno-1-20" name="__codelineno-1-20" href="#__codelineno-1-20"></a>│ │ │ │ style │
<a id="__codelineno-1-21" name="__codelineno-1-21" href="#__codelineno-1-21"></a>│ │ │ │ typing │
<a id="__codelineno-1-22" name="__codelineno-1-22" href="#__codelineno-1-22"></a>└─────────┴─────────────┴────────────────────────────┴────────────┘
<a id="__codelineno-1-23" name="__codelineno-1-23" href="#__codelineno-1-23"></a> Matrices
<a id="__codelineno-1-24" name="__codelineno-1-24" href="#__codelineno-1-24"></a>┏━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┓
<a id="__codelineno-1-25" name="__codelineno-1-25" href="#__codelineno-1-25"></a>┃ Name ┃ Type ┃ Envs ┃ Dependencies ┃ Scripts ┃
<a id="__codelineno-1-26" name="__codelineno-1-26" href="#__codelineno-1-26"></a>┡━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━┩
<a id="__codelineno-1-27" name="__codelineno-1-27" href="#__codelineno-1-27"></a>│ all │ pip-compile │ all.py3.8 │ coverage[toml]&gt;=6.5 │ cov │
<a id="__codelineno-1-28" name="__codelineno-1-28" href="#__codelineno-1-28"></a>│ │ │ all.py3.9 │ pytest │ cov-report │
<a id="__codelineno-1-29" name="__codelineno-1-29" href="#__codelineno-1-29"></a>│ │ │ all.py3.10 │ │ test │
<a id="__codelineno-1-30" name="__codelineno-1-30" href="#__codelineno-1-30"></a>│ │ │ all.py3.11 │ │ test-cov │
<a id="__codelineno-1-31" name="__codelineno-1-31" href="#__codelineno-1-31"></a>│ │ │ all.py3.12 │ │ │
<a id="__codelineno-1-32" name="__codelineno-1-32" href="#__codelineno-1-32"></a>└──────┴─────────────┴────────────┴─────────────────────┴────────────┘
<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a> Standalone
<a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a>┏━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━┓
<a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a>┃ Name ┃ Type ┃ Dependencies ┃ Scripts ┃
<a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a>┡━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━┩
<a id="__codelineno-1-5" name="__codelineno-1-5" href="#__codelineno-1-5"></a>│ default │ pip-compile │ │ │
<a id="__codelineno-1-6" name="__codelineno-1-6" href="#__codelineno-1-6"></a>├─────────┼─────────────┼────────────────────────────┼───────────┤
<a id="__codelineno-1-7" name="__codelineno-1-7" href="#__codelineno-1-7"></a>│ docs │ virtual │ markdown-exec[ansi]~=1.6.0 │ build │
<a id="__codelineno-1-8" name="__codelineno-1-8" href="#__codelineno-1-8"></a>│ │ │ mkdocs-material~=9.2.3 │ deploy │
<a id="__codelineno-1-9" name="__codelineno-1-9" href="#__codelineno-1-9"></a>│ │ │ mkdocstrings~=0.22.0 │ serve │
<a id="__codelineno-1-10" name="__codelineno-1-10" href="#__codelineno-1-10"></a>│ │ │ mkdocs~=1.5.2 │ │
<a id="__codelineno-1-11" name="__codelineno-1-11" href="#__codelineno-1-11"></a>├─────────┼─────────────┼────────────────────────────┼───────────┤
<a id="__codelineno-1-12" name="__codelineno-1-12" href="#__codelineno-1-12"></a>│ gen │ virtual │ │ release │
<a id="__codelineno-1-13" name="__codelineno-1-13" href="#__codelineno-1-13"></a>├─────────┼─────────────┼────────────────────────────┼───────────┤
<a id="__codelineno-1-14" name="__codelineno-1-14" href="#__codelineno-1-14"></a>│ lint │ virtual │ mypy&gt;=1.6.1 │ all │
<a id="__codelineno-1-15" name="__codelineno-1-15" href="#__codelineno-1-15"></a>│ │ │ ruff~=0.1.4 │ fmt │
<a id="__codelineno-1-16" name="__codelineno-1-16" href="#__codelineno-1-16"></a>│ │ │ │ precommit │
<a id="__codelineno-1-17" name="__codelineno-1-17" href="#__codelineno-1-17"></a>│ │ │ │ style │
<a id="__codelineno-1-18" name="__codelineno-1-18" href="#__codelineno-1-18"></a>│ │ │ │ typing │
<a id="__codelineno-1-19" name="__codelineno-1-19" href="#__codelineno-1-19"></a>└─────────┴─────────────┴────────────────────────────┴───────────┘
<a id="__codelineno-1-20" name="__codelineno-1-20" href="#__codelineno-1-20"></a> Matrices
<a id="__codelineno-1-21" name="__codelineno-1-21" href="#__codelineno-1-21"></a>┏━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━━━━┓
<a id="__codelineno-1-22" name="__codelineno-1-22" href="#__codelineno-1-22"></a>┃ Name ┃ Type ┃ Envs ┃
<a id="__codelineno-1-23" name="__codelineno-1-23" href="#__codelineno-1-23"></a>┡━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━━━━┩
<a id="__codelineno-1-24" name="__codelineno-1-24" href="#__codelineno-1-24"></a>│ all │ pip-compile │ all.py3.8 │
<a id="__codelineno-1-25" name="__codelineno-1-25" href="#__codelineno-1-25"></a>│ │ │ all.py3.9 │
<a id="__codelineno-1-26" name="__codelineno-1-26" href="#__codelineno-1-26"></a>│ │ │ all.py3.10 │
<a id="__codelineno-1-27" name="__codelineno-1-27" href="#__codelineno-1-27"></a>│ │ │ all.py3.11 │
<a id="__codelineno-1-28" name="__codelineno-1-28" href="#__codelineno-1-28"></a>│ │ │ all.py3.12 │
<a id="__codelineno-1-29" name="__codelineno-1-29" href="#__codelineno-1-29"></a>└──────┴─────────────┴────────────┘
</code></pre></div>
</div>
</div>
Expand All @@ -645,15 +637,12 @@ <h3 id="hatch-explanation">Hatch Explanation<a class="headerlink" href="#hatch-e
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a> Standalone
<a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a>┏━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┓
<a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a>┃ Name ┃ Type ┃ Dependencies ┃ Scripts ┃
<a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a>┡━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━┩
<a id="__codelineno-1-5" name="__codelineno-1-5" href="#__codelineno-1-5"></a>│ default │ pip-compile │ coverage[toml]&gt;=6.5 │ cov │
<a id="__codelineno-1-6" name="__codelineno-1-6" href="#__codelineno-1-6"></a>│ │ │ pytest │ cov-report │
<a id="__codelineno-1-7" name="__codelineno-1-7" href="#__codelineno-1-7"></a>│ │ │ │ test │
<a id="__codelineno-1-8" name="__codelineno-1-8" href="#__codelineno-1-8"></a>│ │ │ │ test-cov │
<a id="__codelineno-1-9" name="__codelineno-1-9" href="#__codelineno-1-9"></a>└─────────┴─────────────┴─────────────────────┴────────────┘
<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a> Standalone
<a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a>┏━━━━━━━━━┳━━━━━━━━━━━━━┓
<a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a>┃ Name ┃ Type ┃
<a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a>┡━━━━━━━━━╇━━━━━━━━━━━━━┩
<a id="__codelineno-1-5" name="__codelineno-1-5" href="#__codelineno-1-5"></a>│ default │ pip-compile │
<a id="__codelineno-1-6" name="__codelineno-1-6" href="#__codelineno-1-6"></a>└─────────┴─────────────┘
</code></pre></div>
</div>
</div>
Expand Down
Loading

0 comments on commit 5c25df8

Please sign in to comment.