提交 032fc271 authored 作者: Rémi Louf's avatar Rémi Louf 提交者: Brandon T. Willard

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.
上级 3092dab9
...@@ -192,6 +192,36 @@ For a general guide on how to provide open source contributions see `here ...@@ -192,6 +192,36 @@ For a general guide on how to provide open source contributions see `here
For a good overview of the development workflow (e.g. relevant ``git`` commands) For a good overview of the development workflow (e.g. relevant ``git`` commands)
see the `NumPy development guide <https://numpy.org/doc/stable/dev/>`_. see the `NumPy development guide <https://numpy.org/doc/stable/dev/>`_.
Contributing to the documentation
---------------------------------
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:
.. code-block:: bash
pip install -r requirements-rtd.txt
You can now build the documentation from the root of the project with:
.. code-block:: bash
python doc/scripts/docgen.py
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:
.. code-block:: bash
python -m http.server
**Do not commit the `html` directory. The documentation is built automatically.**
Other tools that might help Other tools that might help
=========================== ===========================
......
Markdown 格式
0%
您添加了 0 到此讨论。请谨慎行事。
请先完成此评论的编辑!
注册 或者 后发表评论