diff options
| author | Jason R. Coombs <jaraco@jaraco.com> | 2016-09-27 14:24:22 -0500 |
|---|---|---|
| committer | Jason R. Coombs <jaraco@jaraco.com> | 2016-09-27 14:24:22 -0500 |
| commit | 66a6724da8eda3336643dee086da2a3495e6422a (patch) | |
| tree | 64043e9782491bde3a3a9ae2314cc59451a6c9c0 /docs/developer-guide.txt | |
| parent | df3905616933c90af95e99f705b800a2f5c1c921 (diff) | |
| parent | 35ea365b50bd1a64375fdbcce187affab22af3b7 (diff) | |
| download | python-setuptools-git-setuptools-scm.tar.gz | |
Merge with mastersetuptools-scm
Diffstat (limited to 'docs/developer-guide.txt')
| -rw-r--r-- | docs/developer-guide.txt | 19 |
1 files changed, 7 insertions, 12 deletions
diff --git a/docs/developer-guide.txt b/docs/developer-guide.txt index 7cd3c6d2..70e7f1cd 100644 --- a/docs/developer-guide.txt +++ b/docs/developer-guide.txt @@ -32,8 +32,8 @@ User support and discussions are done through the issue tracker (for specific) issues, through the distutils-sig mailing list, or on IRC (Freenode) at #pypa. -Discussions about development happen on the pypa-dev mailing list or on IRC -(Freenode) at #pypa-dev. +Discussions about development happen on the pypa-dev mailing list or on +`Gitter <https://gitter.im/pypa/setuptools>`_. ----------------- Authoring Tickets @@ -111,15 +111,10 @@ Setuptools follows ``semver``. Building Documentation ---------------------- -Setuptools relies on the Sphinx system for building documentation and in -particular the ``build_sphinx`` distutils command. To build the -documentation, invoke:: +Setuptools relies on the Sphinx system for building documentation. +To accommodate RTD, docs must be built from the docs/ directory. - python setup.py build_sphinx +To build them, you need to have installed the requirements specified +in docs/requirements.txt. One way to do this is to use rwt: -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. + setuptools/docs$ python -m rwt -r requirements.txt -- -m sphinx . html |