summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorPaul Ganssle <pganssle@users.noreply.github.com>2018-05-14 11:10:59 -0400
committerGitHub <noreply@github.com>2018-05-14 11:10:59 -0400
commitd11f10ed20c02a7522ef63b32431a1cdfc786c39 (patch)
treecbb837ff112bb7124f0e71e764e8eedccd5bb671 /docs
parent09541d1eff11a49e39a127724ab09e50c580afda (diff)
parentd564851059813836454f275e9b735f9068cf32c6 (diff)
downloadpython-setuptools-git-d11f10ed20c02a7522ef63b32431a1cdfc786c39.tar.gz
Merge pull request #1352 from jmbowman/jmbowman/tox_docs
Add tox environment for docs
Diffstat (limited to 'docs')
-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/