Add documentation configuration

Change-Id: I6a1bcd9829c024b5a6c6f1dd55a095a19d020028
Issue-ID: CCSDK-2833
Signed-off-by: elinuxhenrik <henrik.b.andersson@est.tech>

diff --git a/.gitignore b/.gitignore
index ec003d1..d0cca38 100644 (file)
--- a/.gitignore
+++ b/.gitignore
@@ -32,3 +32,6 @@ classes
 out/
 .DS_STORE
 .metadata
+
+## Documentation ignores ##
+.tox

diff --git a/docs/_static/favicon.ico b/docs/_static/favicon.ico
new file mode 100755 (executable)
index 0000000..cb712eb
Binary files /dev/null and b/docs/_static/favicon.ico differ

diff --git a/docs/_static/logo_onap_2017.png b/docs/_static/logo_onap_2017.png
new file mode 100755 (executable)
index 0000000..5d064f4
Binary files /dev/null and b/docs/_static/logo_onap_2017.png differ

diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644 (file)
index 0000000..3c4453e
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1 @@
+from docs_conf.conf import *

diff --git a/docs/conf.yaml b/docs/conf.yaml
new file mode 100644 (file)
index 0000000..aad3f82
--- /dev/null
+++ b/docs/conf.yaml
@@ -0,0 +1 @@
+project_cfg: onap

diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644 (file)
index 0000000..0f8726d
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,13 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+   Copyright 2020 Nordix Foundation.
+
+
+.. _ccsdk/oran
+
+ccsdk/oran
+----------
+
+.. toctree::
+   :maxdepth: 1
+
+

diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt
new file mode 100644 (file)
index 0000000..74a3b7a
--- /dev/null
+++ b/docs/requirements-docs.txt
@@ -0,0 +1 @@
+lfdocs-conf

diff --git a/docs/tox.ini b/docs/tox.ini
new file mode 100644 (file)
index 0000000..edac8c3
--- /dev/null
+++ b/docs/tox.ini
@@ -0,0 +1,22 @@
+[tox]
+minversion = 1.6
+envlist = docs,
+skipsdist = true
+
+[testenv:docs]
+basepython = python3
+deps = -r{toxinidir}/requirements-docs.txt
+commands =
+    sphinx-build -b html -n -d {envtmpdir}/doctrees ./ {toxinidir}/_build/html
+    echo "Generated docs available in {toxinidir}/_build/html"
+whitelist_externals =
+    echo
+    git
+    sh
+
+[testenv:docs-linkcheck]
+basepython = python3
+#deps = -r{toxinidir}/requirements-docs.txt
+commands = echo "Link Checking not enforced"
+#commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./ {toxinidir}/_build/linkcheck
+whitelist_externals = echo