diff options
| author |   wenjuan dong <dong.wenjuan@zte.com.cn> | 2018-10-15 09:19:40 +0000 |
|---|---|---|
| committer |   Gerrit Code Review <gerrit@opnfv.org> | 2018-10-15 09:19:40 +0000 |
| commit | 61eb3927ada784cc3dffb5ddd17f66e47871f708 (patch) | |
| tree | 02c8ee8aadafdbb8e264833b84339a2a4688eedc | |
| parent | 0f1dd4314b9e0247d9af7af6df2410462423aeca (diff) | |
| parent | 42333625db781f1ae12212ce903df9b5257ff5e4 (diff) | |
Merge "Local Documentation Builds"
| -rw-r--r-- | .gitignore | 2 | ||||
| -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 | 13 |
5 files changed, 19 insertions, 2 deletions
@@ -6,7 +6,6 @@ /*.egg-info/ .eggs/ /build/ -/docs_build/ /docs_output/ /releng/ /tests/*.img @@ -16,3 +15,4 @@ #Build results .tox +docs/_build/* diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 00000000..eb12e74b --- /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 00000000..e08a41ab --- /dev/null +++ b/docs/conf.yaml @@ -0,0 +1,3 @@ +--- +project_cfg: opnfv +project: DOCTOR diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 00000000..9fde2df2 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,2 @@ +lfdocs-conf +sphinx_opnfv_theme @@ -1,6 +1,6 @@ [tox] minversion = 2.3.1 -envlist = py34, pep8 +envlist = py34, pep8,docs,docs-linkcheck skipsdist = True [testenv] @@ -49,3 +49,14 @@ enable-extensions=H106,H203 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 |