Added structure for OPNFV documentation

Having this structure in place is a requirement for passing release
milestone M2. This change does not modify the content of the
current documentation / deployment guide.

Signed-off-by: Georg Kunz <georg.kunz@ericsson.com>
Change-Id: I07e8820901970da1199f4a474161e49f25707ecc
Reviewed-on: https://gerrit.opnfv.org/gerrit/c/kuberef/+/71298
Tested-by: jenkins-ci <jenkins-opnfv-ci@opnfv.org>
Reviewed-by: Michael Pedersen <michaelx.pedersen@intel.com>
Reviewed-by: Sofia Wallin <sofia.wallin@est.tech>

diff --git a/.gitignore b/.gitignore
index 01a8308..7b15083 100644 (file)
--- a/.gitignore
+++ b/.gitignore
@@ -8,3 +8,4 @@ inventory/group_vars/all/pdf.yaml
 images
 workspace
 .tox
+docs/_build/

diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644 (file)
index 0000000..b281a51
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1,6 @@
+""" for docs
+"""
+
+# pylint: disable=import-error
+# flake8: noqa
+from docs_conf.conf import *

diff --git a/docs/conf.yaml b/docs/conf.yaml
new file mode 100644 (file)
index 0000000..a9bc5de
--- /dev/null
+++ b/docs/conf.yaml
@@ -0,0 +1,3 @@
+---
+project_cfg: opnfv
+project: Kuberef

diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644 (file)
index 0000000..22eafd4
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,18 @@
+.. _kuberef:
+
+.. 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) OPNFV, Ericsson AB and others
+
+*********************************
+OPNFV Kuberef
+*********************************
+
+.. toctree::
+   :numbered:
+   :maxdepth: 3
+
+   release/release-notes/index
+   release/installation/index
+

diff --git a/docs/deployment-guide.rst b/docs/release/installation/deployment-guide.rst
similarity index 100%
rename from docs/deployment-guide.rst
rename to docs/release/installation/deployment-guide.rst

diff --git a/docs/release/installation/index.rst b/docs/release/installation/index.rst
new file mode 100644 (file)
index 0000000..fe2d1af
--- /dev/null
+++ b/docs/release/installation/index.rst
@@ -0,0 +1,17 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) OPNFV, Ericsson AB and others.
+
+.. _kubref-releasenotes:
+
+==================================================
+Kuberef Installation Guide
+==================================================
+
+.. toctree::
+   :numbered:
+   :maxdepth: 2
+
+   deployment-guide.rst
+
+Build date: |today|

diff --git a/docs/release/release-notes/index.rst b/docs/release/release-notes/index.rst
new file mode 100644 (file)
index 0000000..41e6ab3
--- /dev/null
+++ b/docs/release/release-notes/index.rst
@@ -0,0 +1,17 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) OPNFV, Ericsson AB and others.
+
+.. _kubref-releasenotes:
+
+==================================================
+Kuberef Release Notes
+==================================================
+
+.. toctree::
+   :numbered:
+   :maxdepth: 2
+
+   release-notes.rst
+
+Build date: |today|

diff --git a/docs/release/release-notes/release-notes.rst b/docs/release/release-notes/release-notes.rst
new file mode 100644 (file)
index 0000000..c592e8b
--- /dev/null
+++ b/docs/release/release-notes/release-notes.rst
@@ -0,0 +1,8 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) OPNFV, Ericsson AB and others.
+
+Jerma Release
+-------------
+
+TBD

diff --git a/docs/requirements.txt b/docs/requirements.txt
new file mode 100644 (file)
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
index 53ab1a7..0d309d7 100644 (file)
--- a/tox.ini
+++ b/tox.ini
@@ -18,3 +18,14 @@ commands = bash -c "find {toxinidir} \
    bash -c "find {toxinidir} \
    -not -path {toxinidir}/.tox/\* \
    -name \*.rst | xargs rstcheck"
+
+[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