aboutsummaryrefslogtreecommitdiffstats
path: root/docs/developer-guide.txt
diff options
context:
space:
mode:
authorJason R. Coombs <jaraco@jaraco.com>2015-12-31 10:51:55 -0500
committerJason R. Coombs <jaraco@jaraco.com>2015-12-31 10:51:55 -0500
commit29fa01621c3de0a5c78c4f49b5d051386d0d566f (patch)
treefce7387c8ba82178be987b004cbda1c22005a04f /docs/developer-guide.txt
parent928324bd76f35e9c8c526df828577b5640a95ed0 (diff)
parent6bdbe8957d8c8d293e3fea3fa4baf45eb7c3a3a4 (diff)
downloadexternal_python_setuptools-29fa01621c3de0a5c78c4f49b5d051386d0d566f.tar.gz
external_python_setuptools-29fa01621c3de0a5c78c4f49b5d051386d0d566f.tar.bz2
external_python_setuptools-29fa01621c3de0a5c78c4f49b5d051386d0d566f.zip
Merge with master. Ref #229.
--HG-- branch : feature/issue-229
Diffstat (limited to 'docs/developer-guide.txt')
-rw-r--r--docs/developer-guide.txt22
1 files changed, 20 insertions, 2 deletions
diff --git a/docs/developer-guide.txt b/docs/developer-guide.txt
index 558d6ee7..ae33649b 100644
--- a/docs/developer-guide.txt
+++ b/docs/developer-guide.txt
@@ -92,9 +92,10 @@ Testing
The primary tests are run using py.test. To run the tests::
- $ python setup.py ptr
+ $ python setup.py test
-Or install py.test into your environment and run ``py.test``.
+Or install py.test into your environment and run ``PYTHONPATH=. py.test``
+or ``python -m pytest``.
Under continuous integration, additional tests may be run. See the
``.travis.yml`` file for full details on the tests run under Travis-CI.
@@ -109,3 +110,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.