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: Ibbec167d5be1bf68782ede5db7f44e271b3a3ac6
Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
(cherry picked from commit
84a2169aebdd0240f97f248d40931749876515dc)
pep8.log
test.log
.*.sw?
-/docs_build/
/docs_output/
/releng/
+.tox
+docs/_build/*
--- /dev/null
+from docs_conf.conf import *
--- /dev/null
+---
+project_cfg: opnfv
+project: BOTTLENECKS
--- /dev/null
+.. _bottlenecks:
+
+.. 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 Bottlenecks
+*********************************
+
+.. toctree::
+ :numbered:
+ :maxdepth: 3
+
+ release/index
+ testing/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