aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJason R. Coombs <jaraco@jaraco.com>2016-07-23 04:11:35 -0400
committerJason R. Coombs <jaraco@jaraco.com>2016-07-23 04:11:35 -0400
commit8b693597c1bbe6effb24ba209f1f36fd17ee9e90 (patch)
tree9b400a805ef2369deab13a1493ed603d2f0e3fee
parent9fff1f8cdf26b67e8b5299f5295112c5ca5aa40b (diff)
downloadexternal_python_setuptools-8b693597c1bbe6effb24ba209f1f36fd17ee9e90.tar.gz
external_python_setuptools-8b693597c1bbe6effb24ba209f1f36fd17ee9e90.tar.bz2
external_python_setuptools-8b693597c1bbe6effb24ba209f1f36fd17ee9e90.zip
Add docs on building docs
-rw-r--r--docs/developer-guide.txt5
1 files changed, 5 insertions, 0 deletions
diff --git a/docs/developer-guide.txt b/docs/developer-guide.txt
index 3ff77c25..70e7f1cd 100644
--- a/docs/developer-guide.txt
+++ b/docs/developer-guide.txt
@@ -113,3 +113,8 @@ Building Documentation
Setuptools relies on the Sphinx system for building documentation.
To accommodate RTD, docs must be built from the docs/ directory.
+
+To build them, you need to have installed the requirements specified
+in docs/requirements.txt. One way to do this is to use rwt:
+
+ setuptools/docs$ python -m rwt -r requirements.txt -- -m sphinx . html