globuzma/canaille-globuzma
1
0
Fork 0
forked from Github-Mirrors/canaille
Code Pull requests Activity

doc: documentation compilation instructions

Browse source
This commit is contained in:
Éloi Rivard 2024-03-28 14:24:21 +01:00
parent 97470bffe6
commit db84db760f
No known key found for this signature in database
GPG key ID: 7EDA204EA57DD184
1 changed files with 8 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
CONTRIBUTING.rst
View file

@ -155,8 +155,14 @@ Documentation
The documentation is generated when the tests run:
.. code-block:: console
.. code-block:: bash
tox -e doc
The generated documentation is located at `./build/sphinx/html`.
You can also run sphinx by hand, that should be faster since it avoids the tox environment initialization:
.. code-block:: bash
sphinx-build doc build/sphinx/html
The generated documentation is located at ``build/sphinx/html``.