This adds configuration for performing local documentation builds
with the following simple command:
tox -e docs
This patch is part of our documentation effor to Move away from
submodules
https://docs.opnfv.org/en/latest/how-to-use-docs/local-build-transition.html
Your project is now required to have a docs/index.rst so if you are
missing this file please create it.
Change-Id: I32a91a4194e4afe98f4c964052e99419b22330ba
Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
/*.egg-info/
.eggs/
/build/
/*.egg-info/
.eggs/
/build/
/docs_output/
/releng/
/tests/*.img
/docs_output/
/releng/
/tests/*.img
--- /dev/null
+from docs_conf.conf import * # noqa: F401,F403
--- /dev/null
+---
+project_cfg: opnfv
+project: DOCTOR
--- /dev/null
+lfdocs-conf
+sphinx_opnfv_theme
+envlist = py34, pep8,docs,docs-linkcheck
skipsdist = True
[testenv]
skipsdist = True
[testenv]
builtins = _
filename = *.py,app.wsgi
exclude=.venv,.git,.tox,dist,doc,*lib/python*,*egg,build,tests
builtins = _
filename = *.py,app.wsgi
exclude=.venv,.git,.tox,dist,doc,*lib/python*,*egg,build,tests
+
+[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