From 4d59d3530d1c41734f15423142e64eb9c929c717 Mon Sep 17 00:00:00 2001 From: Aric Gardner Date: Tue, 18 Sep 2018 11:05:14 -0400 Subject: Local Documentation Builds This adds configuration for performing local documentation builds with the following simple command: tox -e docs Change-Id: I84d69542d8c603e72d4af460834134d9711ac537 Signed-off-by: Aric Gardner --- tox.ini | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 tox.ini (limited to 'tox.ini') diff --git a/tox.ini b/tox.ini new file mode 100644 index 00000000..69aa1893 --- /dev/null +++ b/tox.ini @@ -0,0 +1,17 @@ +[tox] +minversion = 1.6 +envlist = + docs, + docs-linkcheck +skipsdist = true + +[testenv:docs] +deps = -rdocs/requirements.txt +commands = + sphinx-build -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html + echo "Generated docs available in {toxinidir}/docs/_build/html" +whitelist_externals = echo + +[testenv:docs-linkcheck] +deps = -rdocs/requirements.txt +commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck -- cgit 1.2.3-korg