diff options
author | Aric Gardner <agardner@linuxfoundation.org> | 2018-09-27 14:25:00 -0400 |
---|---|---|
committer | Gergely Csatari <gergely.csatari@nokia.com> | 2018-09-28 08:17:15 +0200 |
commit | 63c1d0f1b1dfc5b64f9b50f20a55e7dcc5d8ca5b (patch) | |
tree | 6b40213f2d8fb3ba26cf278ff0fbe11ae34569a0 | |
parent | 364189da11e212f238db091ff98a016318bcb4f3 (diff) |
Local Documentation Builds
This adds configuration for performing local documentation builds
with the following simple command:
tox -e docs
Change-Id: If60809816322a1dbf0e6b9ef5f4a14db491f7a1e
Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
-rw-r--r-- | .gitignore | 2 | ||||
-rw-r--r-- | docs/conf.py | 1 | ||||
-rw-r--r-- | docs/conf.yaml | 3 | ||||
-rw-r--r-- | docs/index.rst | 15 | ||||
-rw-r--r-- | docs/requirements.txt | 2 | ||||
-rw-r--r-- | tox.ini | 19 |
6 files changed, 42 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..ef64bc8 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +docs/_build/* +.tox 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..a0f3fd0 --- /dev/null +++ b/docs/conf.yaml @@ -0,0 +1,3 @@ +--- +project_cfg: opnfv +project: EDGECLOUD diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..9a20837 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,15 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) Open Platform for NFV Project, Inc. and its contributors + +.. _edgecloud-label: + +******************************** +Edge Cloud Requirements in OPNFV +******************************** +.. toctree:: + :numbered: + :maxdepth: 2 + + development/requirements/requirements.rst + 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,19 @@ +[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 + + |