From db84db760fed3fbe68150ac345fe030c6f52effa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89loi=20Rivard?= Date: Thu, 28 Mar 2024 14:24:21 +0100 Subject: [PATCH] doc: documentation compilation instructions --- CONTRIBUTING.rst | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 724de221..d7ca9517 100644 --- 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``.