summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorAric Gardner <agardner@linuxfoundation.org>2018-09-18 11:01:30 -0400
committerAric Gardner <agardner@linuxfoundation.org>2018-09-28 16:32:16 -0400
commit15a4164a7995aca710d0016ee9e2e1f7a508044b (patch)
tree5a4a666df2ae25848870c8d5de969207d971c5ff /docs
parentd0c0673873f9cfd1752f25d58b760bb2bf51a930 (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: If257dec8d76d3ecf7d75e6cb4771dd9617db7fa4 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/index.rst16
-rw-r--r--docs/requirements.txt2
4 files changed, 22 insertions, 0 deletions
diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644
index 0000000..3c4453e
--- /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 0000000..321ff4d
--- /dev/null
+++ b/docs/conf.yaml
@@ -0,0 +1,3 @@
+---
+project_cfg: opnfv
+project: AVAILABILITY
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 0000000..755651b
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,16 @@
+.. _availability:
+
+.. 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 Availability
+*********************************
+
+.. toctree::
+ :numbered:
+ :maxdepth: 3
+
+ development/overview/index
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