diff options
author | Trevor Bramwell <tbramwell@linuxfoundation.org> | 2018-06-06 15:00:49 +0200 |
---|---|---|
committer | Trevor Bramwell <tbramwell@linuxfoundation.org> | 2018-06-06 15:06:47 +0200 |
commit | af27662f2f47c46d996ed017f9d1b0679bf37bb4 (patch) | |
tree | 518b4b3222f1a9523da5d0171c4facdb602ca767 /tox.ini | |
parent | 2167fff07c7ccdeb33e486e43000f2d6c0a207e4 (diff) |
Enable local documentation builds
Adds a local conf.py and conf.yaml (using lfdocs-conf), to enable local
docs build.
Change-Id: Iaab750983f02476d9bccb6c9bcf2b38544d54d8c
Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>
Diffstat (limited to 'tox.ini')
-rw-r--r-- | tox.ini | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/tox.ini b/tox.ini new file mode 100644 index 00000000..e038b61d --- /dev/null +++ b/tox.ini @@ -0,0 +1,20 @@ +[tox] +envlist = docs,docs-linkcheck +skipsdist = True + +[testenv] +usedevelop = False +setenv= + HOME = {envtmpdir} + PYTHONPATH = {toxinidir} + +[testenv:docs] +deps = -r{toxinidir}/docs/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 = -r{toxinidir}/docs/requirements.txt +commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./docs {toxinidir}/docs/_build/linkcheck |