aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTrevor Bramwell <tbramwell@linuxfoundation.org>2018-06-06 15:00:49 +0200
committerTrevor Bramwell <tbramwell@linuxfoundation.org>2018-06-06 15:06:47 +0200
commitaf27662f2f47c46d996ed017f9d1b0679bf37bb4 (patch)
tree518b4b3222f1a9523da5d0171c4facdb602ca767
parent2167fff07c7ccdeb33e486e43000f2d6c0a207e4 (diff)
Enable local documentation builds
Adds a local conf.py and conf.yaml (using lfdocs-conf), to enable local docs build. Change-Id: Iaab750983f02476d9bccb6c9bcf2b38544d54d8c Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>
-rw-r--r--.gitignore2
-rw-r--r--docs/conf.py1
-rw-r--r--docs/conf.yaml3
-rw-r--r--docs/development/index.rst16
-rw-r--r--docs/index.rst15
-rw-r--r--docs/release/index.rst18
-rw-r--r--docs/requirements.txt2
-rw-r--r--tox.ini20
8 files changed, 77 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore
index 58dd4ee..ffe9352 100644
--- a/.gitignore
+++ b/.gitignore
@@ -4,3 +4,5 @@
*pyc
/sfc.egg-info/
*ovs-logs/
+.tox/
+docs/_build/
diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644
index 0000000..86ab8c5
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1 @@
+from docs_conf.conf import * # flake8: noqa
diff --git a/docs/conf.yaml b/docs/conf.yaml
new file mode 100644
index 0000000..d38bbda
--- /dev/null
+++ b/docs/conf.yaml
@@ -0,0 +1,3 @@
+---
+project_cfg: opnfv
+project: sfc
diff --git a/docs/development/index.rst b/docs/development/index.rst
new file mode 100644
index 0000000..5644372
--- /dev/null
+++ b/docs/development/index.rst
@@ -0,0 +1,16 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. SPDX-License-Identifier: CC-BY-4.0
+.. (c) Open Platform for NFV Project, Inc. and its contributors
+
+.. _sfc-development:
+
+=========================
+Development Documentation
+=========================
+
+.. toctree::
+ :numbered:
+ :maxdepth: 2
+
+ requirements/index
+ design/index
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 0000000..73e87a9
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,15 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. SPDX-License-Identifier: CC-BY-4.0
+.. (c) Open Platform for NFV Project, Inc. and its contributors
+
+.. _sfc:
+
+=========================
+Service Function Chaining
+=========================
+
+.. toctree::
+ :maxdepth: 1
+
+ release/index
+ development/index
diff --git a/docs/release/index.rst b/docs/release/index.rst
new file mode 100644
index 0000000..2fc72e9
--- /dev/null
+++ b/docs/release/index.rst
@@ -0,0 +1,18 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. SPDX-License-Identifier: CC-BY-4.0
+.. (c) Open Platform for NFV Project, Inc. and its contributors
+
+.. _sfc-release:
+
+====================
+Release Documetation
+====================
+
+.. toctree::
+ :numbered:
+ :maxdepth: 1
+
+ configguide/index
+ release-notes/index
+ scenarios/index
+ userguide/index
diff --git a/docs/requirements.txt b/docs/requirements.txt
new file mode 100644
index 0000000..dcb7a59
--- /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..e038b61
--- /dev/null
+++ b/tox.ini
@@ -0,0 +1,20 @@
+[tox]
+envlist = docs,docs-linkcheck
+skipsdist = True
+
+[testenv]
+usedevelop = False
+setenv=
+ HOME = {envtmpdir}
+ PYTHONPATH = {toxinidir}
+
+[testenv:docs]
+deps = -r{toxinidir}/docs/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 = -r{toxinidir}/docs/requirements.txt
+commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./docs {toxinidir}/docs/_build/linkcheck