summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorAric Gardner <agardner@linuxfoundation.org>2018-09-18 12:18:45 -0400
committerAric Gardner <agardner@linuxfoundation.org>2018-10-02 14:04:23 -0400
commit42333625db781f1ae12212ce903df9b5257ff5e4 (patch)
tree72f74828ad1554c2691a92b4a8d032b6fd216e6f /docs
parent825a0a0dd5e8028129b782ed21c549586257b1c5 (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 effor to Move away from submodules https://docs.opnfv.org/en/latest/how-to-use-docs/local-build-transition.html Your project is now required to have a docs/index.rst so if you are missing this file please create it. Change-Id: I32a91a4194e4afe98f4c964052e99419b22330ba 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 00000000..eb12e74b
--- /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 00000000..e08a41ab
--- /dev/null
+++ b/docs/conf.yaml
@@ -0,0 +1,3 @@
+---
+project_cfg: opnfv
+project: DOCTOR
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