Skip to content

Commit 58f28bf

Browse files
Merge pull request #2093 from lwm/add-docs-notes
Add documentation building note.
2 parents 8138d88 + 0aa8915 commit 58f28bf

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

CONTRIBUTING.rst

+10
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,16 @@ Pytest could always use more documentation. What exactly is needed?
7979
You can also edit documentation files directly in the GitHub web interface,
8080
without using a local copy. This can be convenient for small fixes.
8181

82+
.. note::
83+
Build the documentation locally with the following command:
84+
85+
.. code:: bash
86+
87+
$ tox -e docs
88+
89+
The built documentation should be available in the ``doc/en/_build/``.
90+
91+
Where 'en' refers to the documentation language.
8292

8393
.. _submitplugin:
8494

0 commit comments

Comments
 (0)