doc: documentation compilation instructions

yaal-coop · Mar 28, 2024 · db84db7 · db84db7
1 parent 97470bf
commit db84db7
Showing 1 changed file with 8 additions and 2 deletions.
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -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``.