diff options
| author | Jason R. Coombs <jaraco@jaraco.com> | 2015-02-26 13:59:06 -0500 |
|---|---|---|
| committer | Jason R. Coombs <jaraco@jaraco.com> | 2015-02-26 13:59:06 -0500 |
| commit | f85f990c3d581ace1ee88cde5caf4d1927d67739 (patch) | |
| tree | 3e49cb08f66bde8f07e3da2052b55cb7af325073 /docs | |
| parent | dbcd0d78c4e986f7a3aeb13a7fe2c51f486e4680 (diff) | |
| download | python-setuptools-bitbucket-f85f990c3d581ace1ee88cde5caf4d1927d67739.tar.gz | |
Formally describe the supported documentation build process. Fixes #354.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/developer-guide.txt | 17 | ||||
| -rw-r--r-- | docs/development.txt | 1 |
2 files changed, 17 insertions, 1 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. diff --git a/docs/development.txt b/docs/development.txt index 6fe30f6e..455f038a 100644 --- a/docs/development.txt +++ b/docs/development.txt @@ -33,4 +33,3 @@ setuptools changes. You have been warned. developer-guide formats releases - |