From: Aric Gardner Date: Tue, 18 Sep 2018 15:02:33 +0000 (-0400) Subject: Local Documentation Builds X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?a=commitdiff_plain;h=45445fed30e2641ef53b7cfb2fd6b3b1ca3524d0;p=container4nfv.git Local Documentation Builds This adds configuration for performing local documentation builds with the following simple command: tox -e docs Change-Id: I143b0c116d54f0cc864a73829fe240f5a139bbc1 Signed-off-by: Aric Gardner --- diff --git a/.gitignore b/.gitignore index a977916..99b2d4d 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,3 @@ .vagrant/ +.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..b7eb33c --- /dev/null +++ b/docs/conf.yaml @@ -0,0 +1,3 @@ +--- +project_cfg: opnfv +project: CONTAINER4NFV 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 diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..69aa189 --- /dev/null +++ b/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