Skip to content

Commit

Permalink
Regenerate rendered HTML with new pygments version
Browse files Browse the repository at this point in the history
  • Loading branch information
domdfcoding committed Jan 13, 2023
1 parent 8f72844 commit 4c03152
Show file tree
Hide file tree
Showing 14 changed files with 40 additions and 40 deletions.
@@ -1,38 +1,38 @@
<p><tt><span class="pre">hello-world</span></tt> uses <a href="https://tox.readthedocs.io" rel="nofollow">tox</a> to automate testing and packaging,
and <a href="https://pre-commit.com" rel="nofollow">pre-commit</a> to maintain code quality.</p>
<p>Install <tt><span class="pre">pre-commit</span></tt> with <tt>pip</tt> and install the git hook:</p>
<pre>$ python -m pip install pre-commit
$ pre-commit install
<pre>$<span class="w"> </span>python<span class="w"> </span>-m<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>pre-commit<span class="w">
</span>$<span class="w"> </span>pre-commit<span class="w"> </span>install
</pre>
<div id="coding-style">
<h2>Coding style</h2>
<p><a href="https://formate.readthedocs.io" rel="nofollow">formate</a> is used for code formatting.</p>
<p>It can be run manually via <tt><span class="pre">pre-commit</span></tt>:</p>
<pre>$ pre-commit run formate -a
<pre>$<span class="w"> </span>pre-commit<span class="w"> </span>run<span class="w"> </span>formate<span class="w"> </span>-a
</pre>
<p>Or, to run the complete autoformatting suite:</p>
<pre>$ pre-commit run -a
<pre>$<span class="w"> </span>pre-commit<span class="w"> </span>run<span class="w"> </span>-a
</pre>
</div>
<div id="automated-tests">
<h2>Automated tests</h2>
<p>Tests are run with <tt>tox</tt> and <tt>pytest</tt>.
To run tests for a specific Python version, such as Python 3.6:</p>
<pre>$ tox -e py36
<pre>$<span class="w"> </span>tox<span class="w"> </span>-e<span class="w"> </span>py36
</pre>
<p>To run tests for all Python versions, simply run:</p>
<pre>$ tox
<pre>$<span class="w"> </span>tox
</pre>
</div>
<div id="type-annotations">
<h2>Type Annotations</h2>
<p>Type annotations are checked using <tt>mypy</tt>. Run <tt>mypy</tt> using <tt>tox</tt>:</p>
<pre>$ tox -e mypy
<pre>$<span class="w"> </span>tox<span class="w"> </span>-e<span class="w"> </span>mypy
</pre>
</div>
<div id="build-documentation-locally">
<h2>Build documentation locally</h2>
<p>The documentation is powered by Sphinx. A local copy of the documentation can be built with <tt>tox</tt>:</p>
<pre>$ tox -e docs
<pre>$<span class="w"> </span>tox<span class="w"> </span>-e<span class="w"> </span>docs
</pre>
</div>
@@ -1,31 +1,31 @@
<p><span class="docutils literal"><span class="pre">hello-world</span></span> uses <a href="https://tox.readthedocs.io" rel="nofollow">tox</a> to automate testing and packaging,
and <a href="https://pre-commit.com" rel="nofollow">pre-commit</a> to maintain code quality.</p>
<p>Install <span class="docutils literal"><span class="pre">pre-commit</span></span> with <span class="docutils literal">pip</span> and install the git hook:</p>
<pre><code>$ python -m pip install pre-commit
$ pre-commit install</code></pre>
<pre><code>$<span class="w"> </span>python<span class="w"> </span>-m<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>pre-commit<span class="w">
</span>$<span class="w"> </span>pre-commit<span class="w"> </span>install</code></pre>
<section id="coding-style">
<h2>Coding style</h2>
<p><a href="https://formate.readthedocs.io" rel="nofollow">formate</a> is used for code formatting.</p>
<p>It can be run manually via <span class="docutils literal"><span class="pre">pre-commit</span></span>:</p>
<pre><code>$ pre-commit run formate -a</code></pre>
<pre><code>$<span class="w"> </span>pre-commit<span class="w"> </span>run<span class="w"> </span>formate<span class="w"> </span>-a</code></pre>
<p>Or, to run the complete autoformatting suite:</p>
<pre><code>$ pre-commit run -a</code></pre>
<pre><code>$<span class="w"> </span>pre-commit<span class="w"> </span>run<span class="w"> </span>-a</code></pre>
</section>
<section id="automated-tests">
<h2>Automated tests</h2>
<p>Tests are run with <span class="docutils literal">tox</span> and <span class="docutils literal">pytest</span>.
To run tests for a specific Python version, such as Python 3.6:</p>
<pre><code>$ tox -e py36</code></pre>
<pre><code>$<span class="w"> </span>tox<span class="w"> </span>-e<span class="w"> </span>py36</code></pre>
<p>To run tests for all Python versions, simply run:</p>
<pre><code>$ tox</code></pre>
<pre><code>$<span class="w"> </span>tox</code></pre>
</section>
<section id="type-annotations">
<h2>Type Annotations</h2>
<p>Type annotations are checked using <span class="docutils literal">mypy</span>. Run <span class="docutils literal">mypy</span> using <span class="docutils literal">tox</span>:</p>
<pre><code>$ tox -e mypy</code></pre>
<pre><code>$<span class="w"> </span>tox<span class="w"> </span>-e<span class="w"> </span>mypy</code></pre>
</section>
<section id="build-documentation-locally">
<h2>Build documentation locally</h2>
<p>The documentation is powered by Sphinx. A local copy of the documentation can be built with <span class="docutils literal">tox</span>:</p>
<pre><code>$ tox -e docs</code></pre>
<pre><code>$<span class="w"> </span>tox<span class="w"> </span>-e<span class="w"> </span>docs</code></pre>
</section>
Expand Up @@ -32,9 +32,9 @@
<h2>Installation</h2>
<p><tt><span class="pre">hello-world</span></tt> can be installed from PyPI or Anaconda.</p>
<p>To install with <tt>pip</tt>:</p>
<pre>$ python -m pip install hello-world
<pre>$<span class="w"> </span>python<span class="w"> </span>-m<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>hello-world
</pre>
<p>To install with <tt>conda</tt>:</p>
<pre>$ conda install -c conda-forge hello-world
<pre>$<span class="w"> </span>conda<span class="w"> </span>install<span class="w"> </span>-c<span class="w"> </span>conda-forge<span class="w"> </span>hello-world
</pre>
</div>
Expand Up @@ -32,7 +32,7 @@
<h2>Installation</h2>
<p><span class="docutils literal"><span class="pre">hello-world</span></span> can be installed from PyPI or Anaconda.</p>
<p>To install with <span class="docutils literal">pip</span>:</p>
<pre><code>$ python -m pip install hello-world</code></pre>
<pre><code>$<span class="w"> </span>python<span class="w"> </span>-m<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>hello-world</code></pre>
<p>To install with <span class="docutils literal">conda</span>:</p>
<pre><code>$ conda install -c conda-forge hello-world</code></pre>
<pre><code>$<span class="w"> </span>conda<span class="w"> </span>install<span class="w"> </span>-c<span class="w"> </span>conda-forge<span class="w"> </span>hello-world</code></pre>
</section>
Expand Up @@ -32,9 +32,9 @@
<h2>Installation</h2>
<p><tt><span class="pre">hello-world</span></tt> can be installed from PyPI or Anaconda.</p>
<p>To install with <tt>pip</tt>:</p>
<pre>$ python -m pip install hello-world
<pre>$<span class="w"> </span>python<span class="w"> </span>-m<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>hello-world
</pre>
<p>To install with <tt>conda</tt>:</p>
<pre>$ conda install -c conda-forge hello-world
<pre>$<span class="w"> </span>conda<span class="w"> </span>install<span class="w"> </span>-c<span class="w"> </span>conda-forge<span class="w"> </span>hello-world
</pre>
</div>
Expand Up @@ -32,7 +32,7 @@
<h2>Installation</h2>
<p><span class="docutils literal"><span class="pre">hello-world</span></span> can be installed from PyPI or Anaconda.</p>
<p>To install with <span class="docutils literal">pip</span>:</p>
<pre><code>$ python -m pip install hello-world</code></pre>
<pre><code>$<span class="w"> </span>python<span class="w"> </span>-m<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>hello-world</code></pre>
<p>To install with <span class="docutils literal">conda</span>:</p>
<pre><code>$ conda install -c conda-forge hello-world</code></pre>
<pre><code>$<span class="w"> </span>conda<span class="w"> </span>install<span class="w"> </span>-c<span class="w"> </span>conda-forge<span class="w"> </span>hello-world</code></pre>
</section>
Expand Up @@ -32,9 +32,9 @@
<h2>Installation</h2>
<p><tt><span class="pre">hello-world</span></tt> can be installed from PyPI or Anaconda.</p>
<p>To install with <tt>pip</tt>:</p>
<pre>$ python -m pip install hello-world
<pre>$<span class="w"> </span>python<span class="w"> </span>-m<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>hello-world
</pre>
<p>To install with <tt>conda</tt>:</p>
<pre>$ conda install -c conda-forge hello-world
<pre>$<span class="w"> </span>conda<span class="w"> </span>install<span class="w"> </span>-c<span class="w"> </span>conda-forge<span class="w"> </span>hello-world
</pre>
</div>
Expand Up @@ -32,7 +32,7 @@
<h2>Installation</h2>
<p><span class="docutils literal"><span class="pre">hello-world</span></span> can be installed from PyPI or Anaconda.</p>
<p>To install with <span class="docutils literal">pip</span>:</p>
<pre><code>$ python -m pip install hello-world</code></pre>
<pre><code>$<span class="w"> </span>python<span class="w"> </span>-m<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>hello-world</code></pre>
<p>To install with <span class="docutils literal">conda</span>:</p>
<pre><code>$ conda install -c conda-forge hello-world</code></pre>
<pre><code>$<span class="w"> </span>conda<span class="w"> </span>install<span class="w"> </span>-c<span class="w"> </span>conda-forge<span class="w"> </span>hello-world</code></pre>
</section>
Expand Up @@ -32,9 +32,9 @@
<h2>Installation</h2>
<p><tt><span class="pre">hello-world</span></tt> can be installed from PyPI or Anaconda.</p>
<p>To install with <tt>pip</tt>:</p>
<pre>$ python -m pip install hello-world
<pre>$<span class="w"> </span>python<span class="w"> </span>-m<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>hello-world
</pre>
<p>To install with <tt>conda</tt>:</p>
<pre>$ conda install -c conda-forge hello-world
<pre>$<span class="w"> </span>conda<span class="w"> </span>install<span class="w"> </span>-c<span class="w"> </span>conda-forge<span class="w"> </span>hello-world
</pre>
</div>
Expand Up @@ -32,7 +32,7 @@
<h2>Installation</h2>
<p><span class="docutils literal"><span class="pre">hello-world</span></span> can be installed from PyPI or Anaconda.</p>
<p>To install with <span class="docutils literal">pip</span>:</p>
<pre><code>$ python -m pip install hello-world</code></pre>
<pre><code>$<span class="w"> </span>python<span class="w"> </span>-m<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>hello-world</code></pre>
<p>To install with <span class="docutils literal">conda</span>:</p>
<pre><code>$ conda install -c conda-forge hello-world</code></pre>
<pre><code>$<span class="w"> </span>conda<span class="w"> </span>install<span class="w"> </span>-c<span class="w"> </span>conda-forge<span class="w"> </span>hello-world</code></pre>
</section>
Expand Up @@ -32,9 +32,9 @@
<h2>Installation</h2>
<p><tt><span class="pre">hello-world</span></tt> can be installed from PyPI or Anaconda.</p>
<p>To install with <tt>pip</tt>:</p>
<pre>$ python -m pip install hello-world
<pre>$<span class="w"> </span>python<span class="w"> </span>-m<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>hello-world
</pre>
<p>To install with <tt>conda</tt>:</p>
<pre>$ conda install -c conda-forge hello-world
<pre>$<span class="w"> </span>conda<span class="w"> </span>install<span class="w"> </span>-c<span class="w"> </span>conda-forge<span class="w"> </span>hello-world
</pre>
</div>
Expand Up @@ -32,7 +32,7 @@
<h2>Installation</h2>
<p><span class="docutils literal"><span class="pre">hello-world</span></span> can be installed from PyPI or Anaconda.</p>
<p>To install with <span class="docutils literal">pip</span>:</p>
<pre><code>$ python -m pip install hello-world</code></pre>
<pre><code>$<span class="w"> </span>python<span class="w"> </span>-m<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>hello-world</code></pre>
<p>To install with <span class="docutils literal">conda</span>:</p>
<pre><code>$ conda install -c conda-forge hello-world</code></pre>
<pre><code>$<span class="w"> </span>conda<span class="w"> </span>install<span class="w"> </span>-c<span class="w"> </span>conda-forge<span class="w"> </span>hello-world</code></pre>
</section>
Expand Up @@ -32,9 +32,9 @@
<h2>Installation</h2>
<p><tt><span class="pre">hello-world</span></tt> can be installed from PyPI or Anaconda.</p>
<p>To install with <tt>pip</tt>:</p>
<pre>$ python -m pip install hello-world
<pre>$<span class="w"> </span>python<span class="w"> </span>-m<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>hello-world
</pre>
<p>To install with <tt>conda</tt>:</p>
<pre>$ conda install -c conda-forge hello-world
<pre>$<span class="w"> </span>conda<span class="w"> </span>install<span class="w"> </span>-c<span class="w"> </span>conda-forge<span class="w"> </span>hello-world
</pre>
</div>
Expand Up @@ -32,7 +32,7 @@
<h2>Installation</h2>
<p><span class="docutils literal"><span class="pre">hello-world</span></span> can be installed from PyPI or Anaconda.</p>
<p>To install with <span class="docutils literal">pip</span>:</p>
<pre><code>$ python -m pip install hello-world</code></pre>
<pre><code>$<span class="w"> </span>python<span class="w"> </span>-m<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>hello-world</code></pre>
<p>To install with <span class="docutils literal">conda</span>:</p>
<pre><code>$ conda install -c conda-forge hello-world</code></pre>
<pre><code>$<span class="w"> </span>conda<span class="w"> </span>install<span class="w"> </span>-c<span class="w"> </span>conda-forge<span class="w"> </span>hello-world</code></pre>
</section>

0 comments on commit 4c03152

Please sign in to comment.