Skip to content

Commit 71d81bc

Browse files
okotdanieltim-schilling
authored andcommitted
docs: modified troubleshooting section on how to generate docs locally
1 parent d9d0be8 commit 71d81bc

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

docs/contributing.rst

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -227,11 +227,7 @@ Prerequisites
227227

228228
Before building the documentation, ensure that all dependencies are installed as described in
229229
:ref:`the setup instructions <code>`.
230-
If you plan to use *Tox*, make sure it is installed:
231230

232-
.. code-block:: bash
233-
234-
pip install tox
235231

236232

237233
Option 1: Using Make (Linux/macOS)
@@ -272,11 +268,17 @@ You can then open the documentation in your browser:
272268
Troubleshooting
273269
----------------
274270

275-
- If you encounter an error such as ``make: sphinx-build: Command not found``, install Sphinx manually:
276271

277-
.. code-block:: bash
272+
If you encounter an error about a missing dependency such as ``sphinx-build: command not found``,
273+
ensure that your virtual environment is activated and all dependencies are installed:
274+
275+
.. code-block:: bash
278276
279-
pip install sphinx
277+
pip install -r requirements_dev.txt
278+
279+
Alternatively, you can build the documentation using Tox, which automatically handles
280+
dependencies and environment setup:
281+
282+
.. code-block:: bash
280283
281-
- If HTML files are not generated, review the build output for warnings or errors.
282-
- On Windows, if ``make`` is unavailable, use the Tox approach instead.
284+
tox -e docs -- html

0 commit comments

Comments
 (0)