summary |
shortlog |
log |
commit | commitdiff |
review |
tree
raw |
patch |
inline | side by side (from parent 1:
0dacfaa)
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: Iab747c90f7f4b7866270c5850b2792e194b5378a
Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
--- /dev/null
+from docs_conf.conf import *
--- /dev/null
+---
+project_cfg: opnfv
+project: SNAPS
--- /dev/null
+.. _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
--- /dev/null
+lfdocs-conf
+sphinx_opnfv_theme
--- /dev/null
+[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