Daisy: Local docs builds 73/62073/4 master
authorTrevor Bramwell <tbramwell@linuxfoundation.org>
Mon, 10 Sep 2018 22:09:45 +0000 (15:09 -0700)
committerTrevor Bramwell <tbramwell@linuxfoundation.org>
Mon, 22 Oct 2018 18:22:41 +0000 (11:22 -0700)
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>
docs/conf.py [new file with mode: 0644]
docs/conf.yaml [new file with mode: 0644]
docs/index.rst [new file with mode: 0644]
docs/release/installation/index.rst
docs/requirements.txt [new file with mode: 0644]
tox.ini

diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644 (file)
index 0000000..eb12e74
--- /dev/null
@@ -0,0 +1 @@
+from docs_conf.conf import *  # noqa: F401,F403
diff --git a/docs/conf.yaml b/docs/conf.yaml
new file mode 100644 (file)
index 0000000..bb1beaa
--- /dev/null
@@ -0,0 +1,3 @@
+---
+project_cfg: opnfv
+project: daisy
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644 (file)
index 0000000..e6ae4c9
--- /dev/null
@@ -0,0 +1,20 @@
+.. 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
index 611ecf6..3080e14 100644 (file)
@@ -8,7 +8,7 @@ OPNFV Daisy4nfv Installation Guide
 **********************************
 
 .. toctree::
-      :numbered:
+   :numbered:
    :maxdepth: 4
 
    introduction.rst
diff --git a/docs/requirements.txt b/docs/requirements.txt
new file mode 100644 (file)
index 0000000..9fde2df
--- /dev/null
@@ -0,0 +1,2 @@
+lfdocs-conf
+sphinx_opnfv_theme
diff --git a/tox.ini b/tox.ini
index 28fbf8f..7fd6b84 100644 (file)
--- a/tox.ini
+++ b/tox.ini
@@ -25,9 +25,19 @@ setenv=
   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.