diff options
Diffstat (limited to 'docs/developer-guide.txt')
| -rw-r--r-- | docs/developer-guide.txt | 22 |
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. |