Skip to content

Commit

Permalink
DOC: fix sphinx build dir in CONTRIBUTING
Browse files Browse the repository at this point in the history
  • Loading branch information
hagenw committed Jan 25, 2024
1 parent 2a7a9da commit 26d93e2
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,8 @@ and call it directly::

It can be restricted to specific folders::

ruff check audfoo/ tests/
codespell audfoo/ tests/
ruff check auglib/ tests/
codespell auglib/ tests/


.. _codespell: https://github.com/codespell-project/codespell/
Expand All @@ -88,14 +88,14 @@ You can install it and a few other necessary packages with::

To create the HTML pages, use::

python -m sphinx docs/ build/sphinx/html -b html
python -m sphinx docs/ build/html -b html

The generated files will be available
in the directory :file:`build/sphinx/html/`.
in the directory :file:`build/html/`.

It is also possible to automatically check if all links are still valid::

python -m sphinx docs/ build/sphinx/html -b linkcheck
python -m sphinx docs/ build/html -b linkcheck

.. _Sphinx: https://www.sphinx-doc.org

Expand Down

0 comments on commit 26d93e2

Please sign in to comment.