From 63c1d0f1b1dfc5b64f9b50f20a55e7dcc5d8ca5b Mon Sep 17 00:00:00 2001 From: Aric Gardner Date: Thu, 27 Sep 2018 14:25:00 -0400 Subject: Local Documentation Builds This adds configuration for performing local documentation builds with the following simple command: tox -e docs Change-Id: If60809816322a1dbf0e6b9ef5f4a14db491f7a1e Signed-off-by: Aric Gardner --- tox.ini | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 tox.ini (limited to 'tox.ini') diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..ec9d0c4 --- /dev/null +++ b/tox.ini @@ -0,0 +1,19 @@ +[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