diff options
| author |   Trevor Bramwell <tbramwell@linuxfoundation.org> | 2018-03-19 15:09:06 -0700 |
|---|---|---|
| committer | Trevor Bramwell <tbramwell@linuxfoundation.org> | 2018-04-20 16:25:39 -0700 |
| commit | 3affc968eb27e47e2d834773a3150db3c3fce2e6 (patch) | |
| tree | 49a561e04d6eee81500e9eba6bb57e31e83f55bc | |
| parent | 8d84d7d9ac290135804b8ab3f5506e175db8d29e (diff) | |
Enable Local Docs builds by using LF Docs Conf
The docs-conf[1] project will allow releng to have local docs builds
using the OPNFV theme while also not needing to duplicate the opnfvdocs
conf.py file.
[1] https://github.com/lfit/releng-docs-conf
Change-Id: I255faf045eccb363993af9dfb81b487e538cbb41
Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>
| -rw-r--r-- | .gitignore | 1 | ||||
| -rw-r--r-- | docs/conf.py | 1 | ||||
| -rw-r--r-- | docs/conf.yaml | 3 | ||||
| -rw-r--r-- | docs/requirements.txt | 3 | ||||
| -rw-r--r-- | tox.ini | 13 |
5 files changed, 20 insertions, 1 deletions
diff --git a/.gitignore b/.gitignore index 4309e8e26..7790d4615 100644 --- a/.gitignore +++ b/.gitignore @@ -5,6 +5,7 @@ /releng/ .idea *.py[cod] +docs/_build/ .Python env/ diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 000000000..86ab8c577 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1 @@ +from docs_conf.conf import * # flake8: noqa diff --git a/docs/conf.yaml b/docs/conf.yaml new file mode 100644 index 000000000..749a4b1cf --- /dev/null +++ b/docs/conf.yaml @@ -0,0 +1,3 @@ +--- +project_cfg: opnfv +project: releng diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 000000000..f26b04141 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,3 @@ +lfdocs-conf +sphinxcontrib-httpdomain +sphinx-opnfv-theme @@ -4,7 +4,7 @@ # and then run "tox" from this directory. [tox] -envlist = py27 +envlist = jjb,docs,docs-linkcheck skipsdist = True [testenv] @@ -18,3 +18,14 @@ deps = jenkins-job-builder==1.6.1 commands= jenkins-jobs test -o job_output -r jjb/global:{posargs:"jjb/"} + +[testenv:docs] +deps = -r{toxinidir}/docs/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 = -r{toxinidir}/docs/requirements.txt +commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./docs {toxinidir}/docs/_build/linkcheck |