summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorelinuxhenrik <henrik.b.andersson@est.tech>2020-09-21 10:11:08 +0200
committerelinuxhenrik <henrik.b.andersson@est.tech>2020-09-21 14:18:45 +0200
commitc9a39477a2deaa87393be7db8f3895a707c9a33d (patch)
tree8b0c9a54b14d4790e9e007728ddcb6ec57e9f83b
parente800aeabc9b7c30fdf2eedf799b17f00e8272a7e (diff)
Add documentation configuration
Change-Id: I6a1bcd9829c024b5a6c6f1dd55a095a19d020028 Issue-ID: CCSDK-2833 Signed-off-by: elinuxhenrik <henrik.b.andersson@est.tech>
-rw-r--r--.gitignore3
-rwxr-xr-xdocs/_static/favicon.icobin0 -> 2102 bytes
-rwxr-xr-xdocs/_static/logo_onap_2017.pngbin0 -> 12278 bytes
-rw-r--r--docs/conf.py1
-rw-r--r--docs/conf.yaml1
-rw-r--r--docs/index.rst13
-rw-r--r--docs/requirements-docs.txt1
-rw-r--r--docs/tox.ini22
8 files changed, 41 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore
index ec003d1c..d0cca389 100644
--- 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
index 00000000..cb712ebd
--- /dev/null
+++ b/docs/_static/favicon.ico
Binary files differ
diff --git a/docs/_static/logo_onap_2017.png b/docs/_static/logo_onap_2017.png
new file mode 100755
index 00000000..5d064f43
--- /dev/null
+++ b/docs/_static/logo_onap_2017.png
Binary files differ
diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644
index 00000000..3c4453e7
--- /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
index 00000000..aad3f822
--- /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
index 00000000..0f8726d7
--- /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
index 00000000..74a3b7a3
--- /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
index 00000000..edac8c35
--- /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