Skip to content
This repository was archived by the owner on Nov 17, 2025. It is now read-only.

Commit f998465

Browse files
committed
Add instruction to contribute to the documentation
Although the information is burried in another part of the documentation, I could not find any instructions in the the developer starting guide. Since this questions has been asked multiple times in the issue and PR tracker on the repo I added short instructions regarding documentation contributions.
1 parent 006b97a commit f998465

1 file changed

Lines changed: 30 additions & 0 deletions

File tree

doc/dev_start_guide.rst

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -192,6 +192,36 @@ For a general guide on how to provide open source contributions see `here
192192
For a good overview of the development workflow (e.g. relevant ``git`` commands)
193193
see the `NumPy development guide <https://numpy.org/doc/stable/dev/>`_.
194194

195+
196+
Contributing to the documentation
197+
---------------------------------
198+
199+
To contribute to the documentation, first follow the instructions in the previous section. Afterward, you can install the documentation dependencies in the virtual environment you created:
200+
201+
202+
.. code-block:: bash
203+
204+
pip install -r requirements-rtd.txt
205+
206+
207+
You can now build the documentation from the root of the project with:
208+
209+
210+
.. code-block:: bash
211+
212+
python doc/scripts/docgen.py
213+
214+
215+
Afterward, you can go to `html/index.html` and navigate the changes in a browser. One way to do this is to go to the `html` directory and run:
216+
217+
218+
.. code-block:: bash
219+
220+
python -m http.server
221+
222+
**Do not commit the `html` directory. The documentation is built automatically.**
223+
224+
195225
Other tools that might help
196226
===========================
197227

0 commit comments

Comments
 (0)