diff options
| author |   Aric Gardner <agardner@linuxfoundation.org> | 2018-09-18 11:01:58 -0400 |
|---|---|---|
| committer | Aric Gardner <agardner@linuxfoundation.org> | 2018-11-14 19:13:18 +0000 |
| commit | 84a2169aebdd0240f97f248d40931749876515dc (patch) | |
| tree | 6d19c7d6813a95678b2e9963cc59761419e049f0 /tox.ini | |
| parent | b183d7d424e312c585de2b40be0716a8996562f4 (diff) | |
Local Documentation Builds
This adds configuration for performing local documentation builds
with the following simple command:
tox -e docs
added index.rst so that docs build succsesfully
Change-Id: Ibbec167d5be1bf68782ede5db7f44e271b3a3ac6
Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
Diffstat (limited to 'tox.ini')
| -rw-r--r-- | tox.ini | 17 |
1 files changed, 17 insertions, 0 deletions
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 |