Skip to content

Commit

Permalink
DOC: update documentation build instructions (#102)
Browse files Browse the repository at this point in the history
  • Loading branch information
hagenw authored Jul 26, 2024
1 parent 96c3beb commit 38b46ee
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -88,20 +88,20 @@ 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

To ensure that anonymous access is used
when communicating with Artifactory,
you can call instead::

ARTIFACTORY_USERNAME=anonymous ARTIFACTORY_API_KEY="" python -m sphinx docs/ build/sphinx/html -b html
ARTIFACTORY_USERNAME=anonymous ARTIFACTORY_API_KEY="" 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: http://sphinx-doc.org

Expand Down

0 comments on commit 38b46ee

Please sign in to comment.