summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorScott Moser <[email protected]>2015-08-27 14:24:31 -0400
committerScott Moser <[email protected]>2015-08-27 14:24:31 -0400
commit88e7a9b43f042e6c22c64a258fa21a6d4f0932cc (patch)
treec73f99bd8ab28f0e8c8fd7ee1e719daac091ca58
parent820dc69e6cd71999f737e21efe7691f003a2e391 (diff)
add docs rule to Makefile and 'tox -e docs'
This makes it easy to run the docs build either via tox or system sphinx-build in make. bzr-revno: 249.1.1
-rw-r--r--Makefile6
-rw-r--r--doc/conf.py2
-rw-r--r--tox.ini6
3 files changed, 13 insertions, 1 deletions
diff --git a/Makefile b/Makefile
index c222af47..a4a7a6a1 100644
--- a/Makefile
+++ b/Makefile
@@ -22,6 +22,12 @@ unittest:
nosetests $(noseopts) tests/unittests
nosetests3 $(noseopts) tests/unittests
+docs:
+ @which sphinx-build || \
+ { echo "need sphinx-build. get it:"; \
+ echo " apt-get install -qy python3-sphinx"; exit 1; } 1>&2
+ make -C doc html
+
vmtest:
nosetests3 $(noseopts) tests/vmtests
diff --git a/doc/conf.py b/doc/conf.py
index 28713473..66512929 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -91,7 +91,7 @@ pygments_style = 'sphinx'
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
-html_theme = 'default'
+html_theme = 'classic'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
diff --git a/tox.ini b/tox.ini
index 17fc75f5..4c88b716 100644
--- a/tox.ini
+++ b/tox.ini
@@ -24,6 +24,12 @@ deps = {[testenv]deps}
flake8
commands = flake8 {posargs}
+[testenv:docs]
+deps = {[testenv]deps}
+ sphinx
+commands =
+ sphinx-build -b html -d doc/_build/doctrees doc/ doc/_build/html
+
[flake8]
builtins = _
exclude = .venv,.bzr,.tox,dist,doc,*lib/python*,*egg,build