summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAric Gardner <agardner@linuxfoundation.org>2018-10-25 15:58:08 +0000
committerGerrit Code Review <gerrit@opnfv.org>2018-10-25 15:58:08 +0000
commit12bdf4134e0d627b96540f514d479600f73a8545 (patch)
tree290fc905a0234651d268e8e42bcae6ee72cebd81
parent630875f0ac88239f0b9207312793f4d39a5e36bd (diff)
parent1ec589de26715445aeff3e565693f71e472e3496 (diff)
Merge "Local Documentation Builds"
-rw-r--r--.gitignore2
-rw-r--r--docs/conf.py1
-rw-r--r--docs/conf.yaml3
-rw-r--r--docs/index.rst16
-rw-r--r--docs/requirements.txt2
-rw-r--r--tox.ini17
6 files changed, 41 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore
index b3c2444..9292c06 100644
--- a/.gitignore
+++ b/.gitignore
@@ -3,3 +3,5 @@
*.*project
build
dist
+.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..0bb596d
--- /dev/null
+++ b/docs/conf.yaml
@@ -0,0 +1,3 @@
+---
+project_cfg: opnfv
+project: SNAPS
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 0000000..aceb2fc
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,16 @@
+.. _snaps:
+
+.. 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 Snaps
+*********************************
+
+.. toctree::
+ :numbered:
+ :maxdepth: 3
+
+ /how-to-use/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