Skip to content

Commit

Permalink
Deployed af5adee with MkDocs version: 1.5.3
Browse files Browse the repository at this point in the history
  • Loading branch information
forman committed Jan 16, 2024
1 parent cee0ed6 commit f697968
Show file tree
Hide file tree
Showing 11 changed files with 328 additions and 267 deletions.
4 changes: 2 additions & 2 deletions 404.html
Original file line number Diff line number Diff line change
Expand Up @@ -184,11 +184,11 @@


<li class="md-nav__item">
<a href="/intro/" class="md-nav__link">
<a href="/." class="md-nav__link">


<span class="md-ellipsis">
Introduction
Overview
</span>


Expand Down
30 changes: 15 additions & 15 deletions about/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -191,11 +191,11 @@


<li class="md-nav__item">
<a href="../intro/" class="md-nav__link">
<a href=".." class="md-nav__link">


<span class="md-ellipsis">
Introduction
Overview
</span>


Expand Down Expand Up @@ -582,27 +582,27 @@ <h2 id="contributions">Contributions</h2>
corresponding issue. </p>
<h2 id="development">Development</h2>
<p>Setup development environment:</p>
<pre><code class="language-bash">pip install -r requirements.txt
pip install -r requirements-dev.txt
pip install -r requirements-docs.txt
</code></pre>
<div class="highlight"><pre><span></span><code>pip<span class="w"> </span>install<span class="w"> </span>-r<span class="w"> </span>requirements.txt
pip<span class="w"> </span>install<span class="w"> </span>-r<span class="w"> </span>requirements-dev.txt
pip<span class="w"> </span>install<span class="w"> </span>-r<span class="w"> </span>requirements-docs.txt
</code></pre></div>
<h3 id="testing-and-coverage">Testing and Coverage</h3>
<p><code>zappend</code> uses <a href="https://docs.pytest.org/">pytest</a> for unit-level testing
and code coverage analysis.</p>
<pre><code class="language-bash">pytest --cov=zappend tests
</code></pre>
<div class="highlight"><pre><span></span><code>pytest<span class="w"> </span>--cov<span class="o">=</span>zappend<span class="w"> </span>tests
</code></pre></div>
<h3 id="code-style">Code Style</h3>
<p><code>zappend</code> source code is formatted using the <a href="https://black.readthedocs.io/">black</a> tool.</p>
<pre><code class="language-bash">black zappend
</code></pre>
<div class="highlight"><pre><span></span><code>black<span class="w"> </span>zappend
</code></pre></div>
<h3 id="documentation">Documentation</h3>
<p><code>zappend</code> documentation is build using the <a href="https://www.mkdocs.org/">mkdocs</a> tool.</p>
<pre><code class="language-bash">pip install -r requirements-doc.txt
<div class="highlight"><pre><span></span><code>pip<span class="w"> </span>install<span class="w"> </span>-r<span class="w"> </span>requirements-doc.txt

mkdocs build
mkdocs serve
mkdocs gh-deploy
</code></pre>
mkdocs<span class="w"> </span>build
mkdocs<span class="w"> </span>serve
mkdocs<span class="w"> </span>gh-deploy
</code></pre></div>
<h2 id="license">License</h2>
<p><code>zappend</code> is open source made available under the terms and conditions of the
<a href="https://github.com/bcdev/zappend/blob/main/LICENSE">MIT License</a>.</p>
Expand Down
4 changes: 2 additions & 2 deletions api/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -193,11 +193,11 @@


<li class="md-nav__item">
<a href="../intro/" class="md-nav__link">
<a href=".." class="md-nav__link">


<span class="md-ellipsis">
Introduction
Overview
</span>


Expand Down
10 changes: 5 additions & 5 deletions cli/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -193,11 +193,11 @@


<li class="md-nav__item">
<a href="../intro/" class="md-nav__link">
<a href=".." class="md-nav__link">


<span class="md-ellipsis">
Introduction
Overview
</span>


Expand Down Expand Up @@ -370,7 +370,7 @@


<h1 id="command-line-interface-reference">Command Line Interface Reference</h1>
<pre><code>Usage: zappend [OPTIONS] [SLICES]...
<div class="highlight"><pre><span></span><code>Usage: zappend [OPTIONS] [SLICES]...

Create or update a Zarr dataset TARGET from slice datasets SLICES.

Expand All @@ -379,12 +379,12 @@ <h1 id="command-line-interface-reference">Command Line Interface Reference</h1>
passed, subsequent configurations are incremental to
the previous ones.
-t, --target TARGET Target Zarr dataset path or URI. Overrides the
'target_dir' configuration field.
&#39;target_dir&#39; configuration field.
--dry-run Run the tool without creating, changing, or deleting
any files.
--help-config json|md Show configuration help and exit.
--help Show this message and exit.
</code></pre>
</code></pre></div>



Expand Down
4 changes: 2 additions & 2 deletions config/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -193,11 +193,11 @@


<li class="md-nav__item">
<a href="../intro/" class="md-nav__link">
<a href=".." class="md-nav__link">


<span class="md-ellipsis">
Introduction
Overview
</span>


Expand Down
Loading

0 comments on commit f697968

Please sign in to comment.