diff options
| author |   Aric Gardner <agardner@linuxfoundation.org> | 2018-09-18 11:01:58 -0400 |
|---|---|---|
| committer |   Yang (Gabriel) Yu <Gabriel.yuyang@huawei.com> | 2018-11-15 06:02:10 +0000 |
| commit | b38c653c910ed4cf83d6e8d0df1b88b1bb109f4b (patch) | |
| tree | 938858a9d7736dfe8032660e94936cfd946e1433 | |
| parent | 399ec2f328f56c1f81c454ecedfb6b99eaf93c42 (diff) | |
Local Documentation Buildsopnfv-7.1.0
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: Ibbec167d5be1bf68782ede5db7f44e271b3a3ac6
Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
(cherry picked from commit 84a2169aebdd0240f97f248d40931749876515dc)
| -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 | 17 | ||||
| -rw-r--r-- | docs/requirements.txt | 2 | ||||
| -rw-r--r-- | tox.ini | 17 |
6 files changed, 42 insertions, 1 deletions
@@ -25,6 +25,7 @@ dist/ pep8.log test.log .*.sw? -/docs_build/ /docs_output/ /releng/ +.tox +docs/_build/* diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 00000000..3c4453e7 --- /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 00000000..3957686e --- /dev/null +++ b/docs/conf.yaml @@ -0,0 +1,3 @@ +--- +project_cfg: opnfv +project: BOTTLENECKS diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 00000000..f4e9f12d --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,17 @@ +.. _bottlenecks: + +.. 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 Bottlenecks +********************************* + +.. toctree:: + :numbered: + :maxdepth: 3 + + release/index + testing/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 diff --git a/tox.ini b/tox.ini new file mode 100644 index 00000000..69aa1893 --- /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 |