diff options
| author |   Aric Gardner <agardner@linuxfoundation.org> | 2018-09-18 11:01:58 -0400 |
|---|---|---|
| committer | Aric Gardner <agardner@linuxfoundation.org> | 2018-11-14 19:13:18 +0000 |
| commit | 84a2169aebdd0240f97f248d40931749876515dc (patch) | |
| tree | 6d19c7d6813a95678b2e9963cc59761419e049f0 /docs | |
| parent | b183d7d424e312c585de2b40be0716a8996562f4 (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: Ibbec167d5be1bf68782ede5db7f44e271b3a3ac6
Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
Diffstat (limited to 'docs')
| -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 |
4 files changed, 23 insertions, 0 deletions
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 |