diff options
author | Harry Huang <huangxiangyu5@huawei.com> | 2018-09-26 01:48:07 +0000 |
---|---|---|
committer | Gerrit Code Review <gerrit@opnfv.org> | 2018-09-26 01:48:07 +0000 |
commit | 7c6ea0480fd92e648e8bf5e15ee70370ec5332c3 (patch) | |
tree | b69f731da7f765503e25833c3e39684299bd4743 | |
parent | 31e65eda6ec90afdb81f8276780625cd2f1779c4 (diff) | |
parent | 286f48b0dbfa7fdc8b4c58797eeac94f714a57c7 (diff) |
Merge "Local Documentation Builds"
-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 | 17 |
5 files changed, 25 insertions, 1 deletions
@@ -5,6 +5,7 @@ /lib/auto.egg-info /build /dist -/docs_build /docs_output /opnfvdocs +.tox +docs/_build/* diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..3c4453e --- /dev/null +++ b/docs/conf.py @@ -0,0 +1 @@ +from docs_conf.conf import * diff --git a/docs/conf.yaml b/docs/conf.yaml new file mode 100644 index 0000000..ba6ee9d --- /dev/null +++ b/docs/conf.yaml @@ -0,0 +1,3 @@ +--- +project_cfg: opnfv +project: AUTO 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 @@ -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 |