Skip to content

Commit d8d9615

Browse files
committed
docs: modified troubleshooting section on how to generate docs locally
1 parent 8807591 commit d8d9615

File tree

1 file changed

+1
-21
lines changed

1 file changed

+1
-21
lines changed

docs/contributing.rst

Lines changed: 1 addition & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -217,10 +217,6 @@ Building the documentation locally
217217
The project's documentation is built using `Sphinx <https://www.sphinx-doc.org>`_.
218218
You can generate it locally to preview your changes before submitting a pull request.
219219

220-
Two main approaches are supported:
221-
222-
- **Make** – recommended for Linux/macOS users.
223-
- **Tox** – recommended for Windows users or for isolated, consistent builds.
224220

225221
Prerequisites
226222
--------------
@@ -230,23 +226,7 @@ Before building the documentation, ensure that all dependencies are installed as
230226

231227

232228

233-
Option 1: Using Make (Linux/macOS)
234-
----------------------------------
235-
236-
From the project root, run:
237-
238-
.. code-block:: bash
239-
240-
cd docs/
241-
make html
242-
243-
After the build completes, open the generated documentation:
244-
245-
- **macOS:** ``open _build/html/index.html``
246-
- **Linux:** ``xdg-open _build/html/index.html``
247-
248-
249-
Option 2: Using Tox (Cross-Platform)
229+
Using Tox (Cross-Platform)
250230
------------------------------------
251231

252232
To build the documentation using Tox, run from the project root:

0 commit comments

Comments
 (0)