Skip to content

Commit

Permalink
Deploying to pages from @ f50d42e 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
d33bs committed Mar 16, 2024
1 parent 0c025ee commit 09a43ac
Show file tree
Hide file tree
Showing 3 changed files with 1 addition and 3 deletions.
1 change: 0 additions & 1 deletion _sources/contributing.md.txt
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,6 @@ Automated testing is performed using [GitHub Actions](https://docs.github.com/en
Example test command: `% poetry run pytest`
1. [sphinx-build](https://www.sphinx-doc.org/en/master/man/sphinx-build.html) provides documentation website build checks via [`-W`](https://www.sphinx-doc.org/en/master/man/sphinx-build.html#cmdoption-sphinx-build-W) (which turns warnings into errors).
Example command: `% poetry run sphinx-build docs/source docs/build -W`
1. [cffconvert](https://github.com/citation-file-format/cffconvert) provides [CITATION.cff file](https://citation-file-format.github.io/) formatting checks. Example command: `% poetry run cffconvert --validate`
1. [pre-commit](https://pre-commit.com/) provides various checks which are treated as failures in automated testing.
Example command `% pre-commit run -all-files`

Expand Down
1 change: 0 additions & 1 deletion contributing.html
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,6 @@ <h3>Testing<a class="headerlink" href="#testing" title="Permalink to this headin
Example test command: <code class="docutils literal notranslate"><span class="pre">%</span> <span class="pre">poetry</span> <span class="pre">run</span> <span class="pre">pytest</span></code></p></li>
<li><p><a class="reference external" href="https://www.sphinx-doc.org/en/master/man/sphinx-build.html">sphinx-build</a> provides documentation website build checks via <a class="reference external" href="https://www.sphinx-doc.org/en/master/man/sphinx-build.html#cmdoption-sphinx-build-W"><code class="docutils literal notranslate"><span class="pre">-W</span></code></a> (which turns warnings into errors).
Example command: <code class="docutils literal notranslate"><span class="pre">%</span> <span class="pre">poetry</span> <span class="pre">run</span> <span class="pre">sphinx-build</span> <span class="pre">docs/source</span> <span class="pre">docs/build</span> <span class="pre">-W</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/citation-file-format/cffconvert">cffconvert</a> provides <a class="reference external" href="https://citation-file-format.github.io/">CITATION.cff file</a> formatting checks. Example command: <code class="docutils literal notranslate"><span class="pre">%</span> <span class="pre">poetry</span> <span class="pre">run</span> <span class="pre">cffconvert</span> <span class="pre">--validate</span></code></p></li>
<li><p><a class="reference external" href="https://pre-commit.com/">pre-commit</a> provides various checks which are treated as failures in automated testing.
Example command <code class="docutils literal notranslate"><span class="pre">%</span> <span class="pre">pre-commit</span> <span class="pre">run</span> <span class="pre">-all-files</span></code></p></li>
</ol>
Expand Down
Loading

0 comments on commit 09a43ac

Please sign in to comment.