aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAric Gardner <agardner@linuxfoundation.org>2018-09-18 11:04:06 -0400
committerAric Gardner <agardner@linuxfoundation.org>2018-09-28 16:25:11 -0400
commit1a669bfecc76837bf064c74cd382a97ef48310e1 (patch)
treef09702c9732ffce5f75bf9d53ccddd5889c46c4b
parent2f46a8d07f77d202ec41ce6379b8524569a27455 (diff)
Local Documentation BuildsHEADmaster
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: Ifa6f16eccfcadd7f9d86e8d3def5a81b79ecf478 Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
-rw-r--r--.gitignore2
-rw-r--r--docs/conf.py1
-rw-r--r--docs/conf.yaml3
-rw-r--r--docs/index.rst17
-rw-r--r--docs/requirements.txt2
-rw-r--r--tox.ini17
6 files changed, 42 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..71d7636
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,2 @@
+.tox
+docs/_build/*
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..a1d635d
--- /dev/null
+++ b/docs/conf.yaml
@@ -0,0 +1,3 @@
+---
+project_cfg: opnfv
+project: ONOSFW
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 0000000..1f613da
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,17 @@
+.. _onosfw:
+
+.. 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 Onosfw (ONAP-Onosfwmated OPNFV)
+*********************************
+
+.. toctree::
+ :numbered:
+ :maxdepth: 3
+
+ design/index
+ release/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
diff --git a/tox.ini b/tox.ini
new file mode 100644
index 0000000..69aa189
--- /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