Commit d11f10ed authored by Paul Ganssle's avatar Paul Ganssle Committed by GitHub

Merge pull request #1352 from jmbowman/jmbowman/tox_docs

Add tox environment for docs
parents 09541d1e d5648510
...@@ -2,6 +2,7 @@ ...@@ -2,6 +2,7 @@
bin bin
build build
dist dist
docs/build
include include
lib lib
distribute.egg-info distribute.egg-info
......
...@@ -106,10 +106,12 @@ Setuptools follows ``semver``. ...@@ -106,10 +106,12 @@ Setuptools follows ``semver``.
Building Documentation Building Documentation
---------------------- ----------------------
Setuptools relies on the Sphinx system for building documentation. Setuptools relies on the `Sphinx`_ system for building documentation.
To accommodate RTD, docs must be built from the docs/ directory. The `published documentation`_ is hosted on Read the Docs.
To build them, you need to have installed the requirements specified To build the docs locally, use tox::
in docs/requirements.txt. One way to do this is to use rwt:
setuptools/docs$ python -m rwt -r requirements.txt -- -m sphinx . html $ tox -e docs
.. _Sphinx: http://www.sphinx-doc.org/en/master/
.. _published documentation: https://setuptools.readthedocs.io/en/latest/
...@@ -33,6 +33,14 @@ deps=codecov ...@@ -33,6 +33,14 @@ deps=codecov
skip_install=True skip_install=True
commands=codecov --file {toxworkdir}/coverage.xml commands=codecov --file {toxworkdir}/coverage.xml
[testenv:docs]
deps = -r{toxinidir}/docs/requirements.txt
skip_install=True
commands =
python {toxinidir}/bootstrap.py
sphinx-build -b html -d {envtmpdir}/doctrees docs docs/build/html
sphinx-build -b man -d {envtmpdir}/doctrees docs docs/build/man
[coverage:run] [coverage:run]
source= source=
pkg_resources pkg_resources
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment