diff options
| author |   Aric Gardner <agardner@linuxfoundation.org> | 2018-09-18 11:06:19 -0400 |
|---|---|---|
| committer | Aric Gardner <agardner@linuxfoundation.org> | 2018-11-09 15:08:44 -0500 |
| commit | ac6f1684311e6311aa81c0135bf18ee57fbbff6d (patch) | |
| tree | 01f45f95a77a283c3684ed2a7ce2a6329a58dc7e | |
| parent | 96de8654952a606d28d56c057ba871b5553e4176 (diff) | |
Local Documentation Builds
When this is merged docs will be avaliable at
https://opnfv-vswitchperf.readthedocs.io/en/latest/
This adds configuration for performing local documentation builds
with the following simple command:
tox -e docs
Also added index.rst
Change-Id: Ie5deaec6c94fc39d3a086df1a2ddec7c2829efd5
Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
| -rw-r--r-- | .gitignore | 3 | ||||
| -rw-r--r-- | docs/conf.py | 6 | ||||
| -rw-r--r-- | docs/conf.yaml | 3 | ||||
| -rw-r--r-- | docs/index.rst | 21 | ||||
| -rw-r--r-- | docs/requirements.txt | 2 | ||||
| -rw-r--r-- | tox.ini | 17 |
6 files changed, 50 insertions, 2 deletions
@@ -47,7 +47,6 @@ coverage.xml *.log # Sphinx documentation -docs/_build/ # PyBuilder target/ @@ -58,7 +57,6 @@ target/ *~ .*.sw? -/docs_build/ /docs_output/ /releng/ /src/dpdk/dpdk/ @@ -78,3 +76,4 @@ tags !/src/l2fwd/LICENSE.txt !/src/l2fwd/Makefile +docs/_build/* diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 00000000..b281a515 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,6 @@ +""" for docs +""" + +# pylint: disable=import-error +# flake8: noqa +from docs_conf.conf import * diff --git a/docs/conf.yaml b/docs/conf.yaml new file mode 100644 index 00000000..59448e39 --- /dev/null +++ b/docs/conf.yaml @@ -0,0 +1,3 @@ +--- +project_cfg: opnfv +project: VSWITCHPERF diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 00000000..d76a1952 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,21 @@ +.. _vswitchperf: + +.. 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 Vswitchperf +********************************* + +.. toctree:: + :numbered: + :maxdepth: 3 + + release/release-notes/index + testing/developer/devguide/index + testing/developer/devguide/results/index + testing/user/configguide/index + testing/user/userguide/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 |