Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: fix sphinx build dir in CONTRIBUTING #8

Merged
merged 1 commit into from
Jan 25, 2024
Merged

DOC: fix sphinx build dir in CONTRIBUTING #8

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions CONTRIBUTING.rst
View file
Open in desktop
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
Loading