diff options
| author |   Aric Gardner <agardner@linuxfoundation.org> | 2018-09-18 11:05:26 -0400 |
|---|---|---|
| committer | Aric Gardner <agardner@linuxfoundation.org> | 2018-10-02 13:54:02 -0400 |
| commit | 72c03e11197ad3eb9a532d9605bd64a6f9d82050 (patch) | |
| tree | ab3528128dc7b6acaf05afc33e4aa35db4323262 | |
| parent | 64a5e7dc89be1c52253a48fb5ccfa045b6619d0f (diff) | |
Local Documentation Builds
This adds configuration for performing local documentation builds
with the following simple command:
tox -e docs
added index.rst so that docs build succsesfully
Change-Id: Ib0c7626c37b7f733641fcf2174d9951bf2371886
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 | 23 | ||||
| -rw-r--r-- | docs/requirements.txt | 2 | ||||
| -rw-r--r-- | tox.ini | 17 |
6 files changed, 48 insertions, 1 deletions
@@ -3,7 +3,6 @@ *.pyc *~ .*.sw? -/docs_build/ /docs_output/ /releng/ *.tar.gz @@ -13,3 +12,5 @@ odl-pipeline/build/* odl-pipeline/trash/* odl-pipeline/lib/tmp odl-pipeline/disks/* +.tox +docs/_build/* diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..eb12e74 --- /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 0000000..4175c7c --- /dev/null +++ b/docs/conf.yaml @@ -0,0 +1,3 @@ +--- +project_cfg: opnfv +project: SDNVPN diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..d07beb2 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,23 @@ +.. _sdnvpn: + +.. 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 SDNVPN +********************************* + +.. toctree:: + :numbered: + :maxdepth: 3 + + release/release-notes/index + release/configguide/index + release/userguide/index + release/installation/index + development/requirements/index + development/overview/index + development/design/index + 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 |