summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.rst
diff options
context:
space:
mode:
authorLuke Murphy <lukewm@riseup.net>2016-11-26 18:57:51 +0100
committerLuke Murphy <lukewm@riseup.net>2016-11-26 18:57:51 +0100
commit0aa891543d4b3961e600f2f153f57bdff4f3963f (patch)
tree6f336f75185ae793cd811623aa670aeed7a0bbe7 /CONTRIBUTING.rst
parenta6084ed79756c1d1a01bbf6d50e501d14dd407d0 (diff)
downloadpytest-0aa891543d4b3961e600f2f153f57bdff4f3963f.tar.gz
Add documentation building note.
Diffstat (limited to 'CONTRIBUTING.rst')
-rw-r--r--CONTRIBUTING.rst10
1 files changed, 10 insertions, 0 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index 19b31c7f4..71dc04d91 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -79,6 +79,16 @@ Pytest could always use more documentation. What exactly is needed?
You can also edit documentation files directly in the GitHub web interface,
without using a local copy. This can be convenient for small fixes.
+.. note::
+ Build the documentation locally with the following command:
+
+ .. code:: bash
+
+ $ tox -e docs
+
+ The built documentation should be available in the ``doc/en/_build/``.
+
+ Where 'en' refers to the documentation language.
.. _submitplugin: