diff options
| author |   Trevor Bramwell <tbramwell@linuxfoundation.org> | 2018-06-04 14:36:44 +0200 |
|---|---|---|
| committer | Trevor Bramwell <tbramwell@linuxfoundation.org> | 2018-08-03 12:14:11 -0700 |
| commit | 8f28a9846b2ec7470004f3203a1d3b380855726e (patch) | |
| tree | af6d60e9bc54851c2eb0db75b9a6f86def8200ab /docs/how-to-use-docs/files/tox.ini | |
| parent | 30941c8136548e14ea5bb4486d3bea9d568c93bd (diff) | |
Submodule to RTD transition documentation
Adds documentation for current projects on how to migrate to using local
doc builds, along with steps for new projects to setup their builds.
Issue: DOCS-191
Change-Id: I1c850457dec1006199d095ad63469af1ca02a760
Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>
Diffstat (limited to 'docs/how-to-use-docs/files/tox.ini')
| -rw-r--r-- | docs/how-to-use-docs/files/tox.ini | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/how-to-use-docs/files/tox.ini b/docs/how-to-use-docs/files/tox.ini new file mode 100644 index 000000000..69aa18937 --- /dev/null +++ b/docs/how-to-use-docs/files/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 |