summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorAric Gardner <agardner@linuxfoundation.org>2018-09-18 12:59:30 -0400
committerAric Gardner <agardner@linuxfoundation.org>2018-10-25 12:08:48 -0400
commit4e54b544e3b2bc4e06631a24659a28f15d9b2490 (patch)
tree8ea973f056560413a45d0e32a007512345f1434c /docs
parent59db88a0554459514e40fd512e3d105820a9086f (diff)
Local Documentation Builds
This adds configuration for performing local documentation builds with the following simple command: tox -e docs This patch is part of our documentation effort to Move away from submodules https://docs.opnfv.org/en/latest/how-to-use-docs/local-build-transition.html Once merged docs will be viewable at opnfv-nfvbench.readthedocs.io Change-Id: I7c877847ec23c4cfc44ff7f106ed2acc65688a41 Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
Diffstat (limited to 'docs')
-rw-r--r--docs/conf.py1
-rw-r--r--docs/conf.yaml3
-rw-r--r--docs/requirements.txt2
3 files changed, 6 insertions, 0 deletions
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..4e26a1c
--- /dev/null
+++ b/docs/conf.yaml
@@ -0,0 +1,3 @@
+---
+project_cfg: opnfv
+project: NFVBENCH
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