From 0dc29630918288846f3a398d884de8ecd9db7ced Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Thu, 26 Feb 2015 13:59:06 -0500 Subject: Formally describe the supported documentation build process. Fixes #354. --- docs/developer-guide.txt | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) (limited to 'docs/developer-guide.txt') 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. -- cgit v1.2.3 From a88effc90cdc99974ae65c008238566cdab4b98e Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Sat, 21 Nov 2015 10:42:48 -0500 Subject: Update docs to reflect preferred usage with latest pytest-runner. --- docs/developer-guide.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/developer-guide.txt') diff --git a/docs/developer-guide.txt b/docs/developer-guide.txt index 27c304e5..b6f5bb9f 100644 --- a/docs/developer-guide.txt +++ b/docs/developer-guide.txt @@ -92,7 +92,7 @@ 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``. -- cgit v1.2.3 From 63c3e2e1ba805f64ad251a90c1182bdd06e28a12 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Wed, 25 Nov 2015 10:44:07 -0500 Subject: Update tox tests so they run the full suite of tests using the canonical technique. Include .tox in norecursedirs to avoid testing all the dependencies and environment. Update docs to reflect findings (https://bitbucket.org/spookylukey/setuptools/commits/88339d2e4af661a60a42bc14c4ff3e68cd19fa21#comment-2558164). --- docs/developer-guide.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'docs/developer-guide.txt') diff --git a/docs/developer-guide.txt b/docs/developer-guide.txt index b6f5bb9f..ae33649b 100644 --- a/docs/developer-guide.txt +++ b/docs/developer-guide.txt @@ -94,7 +94,8 @@ The primary tests are run using py.test. To run the tests:: $ 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. -- cgit v1.2.3