diff options
| author |   Aric Gardner <agardner@linuxfoundation.org> | 2018-09-18 11:06:19 -0400 |
|---|---|---|
| committer | Aric Gardner <agardner@linuxfoundation.org> | 2018-11-09 15:08:44 -0500 |
| commit | ac6f1684311e6311aa81c0135bf18ee57fbbff6d (patch) | |
| tree | 01f45f95a77a283c3684ed2a7ce2a6329a58dc7e /tox.ini | |
| parent | 96de8654952a606d28d56c057ba871b5553e4176 (diff) | |
Local Documentation Builds
When this is merged docs will be avaliable at
https://opnfv-vswitchperf.readthedocs.io/en/latest/
This adds configuration for performing local documentation builds
with the following simple command:
tox -e docs
Also added index.rst
Change-Id: Ie5deaec6c94fc39d3a086df1a2ddec7c2829efd5
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 |