aboutsummaryrefslogtreecommitdiffstats
path: root/docs/developer-guide.txt
diff options
context:
space:
mode:
authorJason R. Coombs <jaraco@jaraco.com>2015-02-26 13:59:06 -0500
committerJason R. Coombs <jaraco@jaraco.com>2015-02-26 13:59:06 -0500
commit0dc29630918288846f3a398d884de8ecd9db7ced (patch)
tree558bbfe38f5da3d8b6d3a9ac1a6b9ac0e0fded27 /docs/developer-guide.txt
parent3bf060e378ce5d942079452450864ef30bdaa44f (diff)
downloadexternal_python_setuptools-0dc29630918288846f3a398d884de8ecd9db7ced.tar.gz
external_python_setuptools-0dc29630918288846f3a398d884de8ecd9db7ced.tar.bz2
external_python_setuptools-0dc29630918288846f3a398d884de8ecd9db7ced.zip
Formally describe the supported documentation build process. Fixes #354.
Diffstat (limited to 'docs/developer-guide.txt')
-rw-r--r--docs/developer-guide.txt17
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/developer-guide.txt b/docs/developer-guide.txt
index 558d6ee7..27c304e5 100644
--- a/docs/developer-guide.txt
+++ b/docs/developer-guide.txt
@@ -109,3 +109,20 @@ Setuptools follows ``semver`` with some exceptions:
- Omits 'v' prefix for tags.
.. explain value of reflecting meaning in versions.
+
+----------------------
+Building Documentation
+----------------------
+
+Setuptools relies on the Sphinx system for building documentation and in
+particular the ``build_sphinx`` distutils command. To build the
+documentation, invoke::
+
+ python setup.py build_sphinx
+
+from the root of the repository. Setuptools will download a compatible
+build of Sphinx and any requisite plugins and then build the
+documentation in the build/sphinx directory.
+
+Setuptools does not support invoking the doc builder from the docs/
+directory as some tools expect.