diff options
| author |   Aric Gardner <agardner@linuxfoundation.org> | 2018-09-18 12:59:30 -0400 |
|---|---|---|
| committer | Aric Gardner <agardner@linuxfoundation.org> | 2018-10-25 12:08:48 -0400 |
| commit | 4e54b544e3b2bc4e06631a24659a28f15d9b2490 (patch) | |
| tree | 8ea973f056560413a45d0e32a007512345f1434c | |
| parent | 59db88a0554459514e40fd512e3d105820a9086f (diff) | |
Local Documentation Builds
This adds configuration for performing local documentation builds
with the following simple command:
tox -e docs
This patch is part of our documentation effort to Move away from
submodules
https://docs.opnfv.org/en/latest/how-to-use-docs/local-build-transition.html
Once merged docs will be viewable at opnfv-nfvbench.readthedocs.io
Change-Id: I7c877847ec23c4cfc44ff7f106ed2acc65688a41
Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
| -rw-r--r-- | .gitignore | 3 | ||||
| -rw-r--r-- | docs/conf.py | 1 | ||||
| -rw-r--r-- | docs/conf.yaml | 3 | ||||
| -rw-r--r-- | docs/requirements.txt | 2 | ||||
| -rw-r--r-- | tox.ini | 16 |
5 files changed, 19 insertions, 6 deletions
@@ -10,9 +10,8 @@ nfvbench.egg-info nfvbenchvm/dib/dib-venv nfvbenchvm/dib/nfvbenchvm_centos-*.d/ *.qcow2 -docs/_build -docs/conf.py docs/_static build/ AUTHORS ChangeLog +docs/_build/* diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..eb12e74 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1 @@ +from docs_conf.conf import * # noqa: F401,F403 diff --git a/docs/conf.yaml b/docs/conf.yaml new file mode 100644 index 0000000..4e26a1c --- /dev/null +++ b/docs/conf.yaml @@ -0,0 +1,3 @@ +--- +project_cfg: opnfv +project: NFVBENCH diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..9fde2df --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,2 @@ +lfdocs-conf +sphinx_opnfv_theme @@ -1,6 +1,6 @@ [tox] minversion = 1.6 -envlist = py27,pep8, lint +envlist = py27,pep8,lint,docs,docs-linkcheck skipsdist = True [testenv] @@ -24,9 +24,6 @@ commands = {posargs} [testenv:cover] commands = python setup.py testr --coverage --testr-args='{posargs}' -[testenv:docs] -commands = python setup.py build_sphinx - [flake8] # H803 skipped on purpose per list discussion. # E123, E125 skipped as they are invalid PEP-8. @@ -43,3 +40,14 @@ show-source = True ignore = E123,E125,H803,E302,E303,H104,H233,H236,H302,H404,H405,H904,D102,D100,D107 builtins = _ exclude=venv,.git,.tox,dist,doc,*openstack/common*,*lib/python*,*egg,build,dib-venv + +[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 |