Adds local documentation builds following this guide:
https://docs.opnfv.org/en/latest/how-to-use-docs/local-build-transition.html
docs can be build with
tox -e docs
Going forward docs will be hosted here:
https://opnfv-daisy.readthedocs.io/en/latest/
Change-Id: Iecb230463dfb96101cc5cf01af71cb54318ca732
Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>
--- /dev/null
+from docs_conf.conf import * # noqa: F401,F403
--- /dev/null
+---
+project_cfg: opnfv
+project: daisy
--- /dev/null
+.. 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
+
+.. _daisy:
+
+=========
+Daisy4NFV
+=========
+
+.. toctree::
+ :maxdepth: 2
+
+ release/installation/index
+ release/configguide/index
+ release/release-notes/index
+ development/design/index
+ development/requirement/multicast
+ test
**********************************
.. toctree::
- :numbered:
+ :numbered:
:maxdepth: 4
introduction.rst
--- /dev/null
+lfdocs-conf
+sphinx_opnfv_theme
PYTHONPATH = {toxinidir}
[testenv:pep8]
+usedevelop = False
deps = flake8
commands = flake8 {toxinidir}
+[testenv:docs]
+usedevelop = False
+deps = -rdocs/requirements.txt
+commands =
+ sphinx-build -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
+
+[testenv:docs-linkcheck]
+commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck
+
[flake8]
# H803 skipped on purpose per list discussion.
# E123, E125 skipped as they are invalid PEP-8.