summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorNikos Karandreas <nick@intracom-telecom.com>2018-10-04 10:02:01 +0000
committerGerrit Code Review <gerrit@opnfv.org>2018-10-04 10:02:01 +0000
commit7b1b9e2ff57ceb2a75b3d60b95262c12e1823586 (patch)
tree6b20e7aa8d3c03b522171783b3a336a2dba24877
parent4d9843200ef1dde2442667cd077afb24f09087ba (diff)
parent72c03e11197ad3eb9a532d9605bd64a6f9d82050 (diff)
Merge "Local Documentation Builds"
-rw-r--r--.gitignore3
-rw-r--r--docs/conf.py1
-rw-r--r--docs/conf.yaml3
-rw-r--r--docs/index.rst23
-rw-r--r--docs/requirements.txt2
-rw-r--r--tox.ini17
6 files changed, 48 insertions, 1 deletions
diff --git a/.gitignore b/.gitignore
index 332a121..444a0cb 100644
--- a/.gitignore
+++ b/.gitignore
@@ -3,7 +3,6 @@
*.pyc
*~
.*.sw?
-/docs_build/
/docs_output/
/releng/
*.tar.gz
@@ -13,3 +12,5 @@ odl-pipeline/build/*
odl-pipeline/trash/*
odl-pipeline/lib/tmp
odl-pipeline/disks/*
+.tox
+docs/_build/*
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..4175c7c
--- /dev/null
+++ b/docs/conf.yaml
@@ -0,0 +1,3 @@
+---
+project_cfg: opnfv
+project: SDNVPN
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 0000000..d07beb2
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,23 @@
+.. _sdnvpn:
+
+.. 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 SDNVPN
+*********************************
+
+.. toctree::
+ :numbered:
+ :maxdepth: 3
+
+ release/release-notes/index
+ release/configguide/index
+ release/userguide/index
+ release/installation/index
+ development/requirements/index
+ development/overview/index
+ development/design/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