From af27662f2f47c46d996ed017f9d1b0679bf37bb4 Mon Sep 17 00:00:00 2001 From: Trevor Bramwell Date: Wed, 6 Jun 2018 15:00:49 +0200 Subject: 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 --- tox.ini | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 tox.ini (limited to 'tox.ini') 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 -- cgit 1.2.3-korg