diff options
| author |   Aric Gardner <agardner@linuxfoundation.org> | 2018-09-18 12:10:43 -0400 |
|---|---|---|
| committer | Aric Gardner <agardner@linuxfoundation.org> | 2018-10-02 13:56:37 -0400 |
| commit | 9666d8bb3df726d88d08d5811d2a99e713908396 (patch) | |
| tree | 2d6610abee50cdd3b0bd2a3c2159e6e257904e9d | |
| parent | 82bf9da27ea0c973068720d440e3391084e8a9d9 (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 effor to Move away from submodules
https://docs.opnfv.org/en/latest/how-to-use-docs/local-build-transition.html
added index.rst so that docs build succsesfully
Change-Id: I2d28f03ad4d5c9c14de095dc544257af9d1e51d9
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/index.rst | 24 | ||||
| -rw-r--r-- | docs/requirements.txt | 2 | ||||
| -rw-r--r-- | tox.ini | 12 |
6 files changed, 43 insertions, 2 deletions
@@ -1,6 +1,5 @@ *~ *.pyc -/docs_build/ /docs_output/ /releng/ venv/ @@ -10,3 +9,5 @@ nosetests.xml .* *.log *.retry +.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..6c76e3c0 --- /dev/null +++ b/docs/conf.yaml @@ -0,0 +1,3 @@ +--- +project_cfg: opnfv +project: APEX diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 00000000..01f8c19f --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,24 @@ +.. _apex: + +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. SPDX-License-Identifier CC-BY-4.0 +.. (c) Open Platform for NFV Project, Inc. and its contributors + +********************************* +OPNFV Apex +********************************* + +.. toctree:: + :numbered: + :maxdepth: 3 + + release/scenarios/os-nosdn-nofeature-noha/index + release/scenarios/os-nosdn-performance-ha/index + release/scenarios/os-ovn-nofeature-noha/index + release/scenarios/os-nosdn-nofeature-ha/index + release/scenarios/os-odl-nofeature-noha/index + release/scenarios/os-odl-nofeature-ha/index + release/scenarios/k8s-nosdn-nofeature-noha/index + release/installation/index + release/release-notes/index 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,5 +1,5 @@ [tox] -envlist = docs,pep8,pylint,py35 +envlist = docs,docs-linkcheck,pep8,pylint,py35 [testenv] usedevelop = True @@ -24,3 +24,13 @@ commands = flake8 --exclude .build,build --ignore=F401 [testenv:py35] basepython = python3 +[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 |