aboutsummaryrefslogtreecommitdiffstats
path: root/docs/developer-guide.txt
diff options
context:
space:
mode:
authorJeremy Bowman <jbowman@edx.org>2018-05-14 09:42:59 -0400
committerJeremy Bowman <jbowman@edx.org>2018-05-14 09:54:20 -0400
commitd564851059813836454f275e9b735f9068cf32c6 (patch)
tree93b74840281b6b1e3b142719ff3236900ebfee81 /docs/developer-guide.txt
parent4ec8524932d715b5bc71a03ce81b96df195f6722 (diff)
downloadexternal_python_setuptools-d564851059813836454f275e9b735f9068cf32c6.tar.gz
external_python_setuptools-d564851059813836454f275e9b735f9068cf32c6.tar.bz2
external_python_setuptools-d564851059813836454f275e9b735f9068cf32c6.zip
Add tox environment for docs
Diffstat (limited to 'docs/developer-guide.txt')
-rw-r--r--docs/developer-guide.txt12
1 files changed, 7 insertions, 5 deletions
diff --git a/docs/developer-guide.txt b/docs/developer-guide.txt
index b2c1a0ce..85210055 100644
--- a/docs/developer-guide.txt
+++ b/docs/developer-guide.txt
@@ -106,10 +106,12 @@ Setuptools follows ``semver``.
Building Documentation
----------------------
-Setuptools relies on the Sphinx system for building documentation.
-To accommodate RTD, docs must be built from the docs/ directory.
+Setuptools relies on the `Sphinx`_ system for building documentation.
+The `published documentation`_ is hosted on Read the Docs.
-To build them, you need to have installed the requirements specified
-in docs/requirements.txt. One way to do this is to use rwt:
+To build the docs locally, use tox::
- setuptools/docs$ python -m rwt -r requirements.txt -- -m sphinx . html
+ $ tox -e docs
+
+.. _Sphinx: http://www.sphinx-doc.org/en/master/
+.. _published documentation: https://setuptools.readthedocs.io/en/latest/