fix doc config files

Issue-ID: DOC-798

Signed-off-by: thmsdt <thomas.kulik@telekom.de>
Change-Id: Ic9b28d272a136c28e8be2ee41639c2e2995366d7

diff --git a/.gitreview b/.gitreview
index bbc52e5..160588b 100644 (file)
--- a/.gitreview
+++ b/.gitreview
@@ -2,4 +2,4 @@
 host=gerrit.onap.org
 port=29418
 project=holmes/rule-management.git
-defaultbranch=master
+defaultbranch=kohn

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
index a1f1b04..dc0c78b 100644 (file)
--- a/.readthedocs.yaml
+++ b/.readthedocs.yaml
@@ -18,4 +18,4 @@ submodules:
   include: all
 
 sphinx:
-  configuration: docs/conf.py
\ No newline at end of file
+  configuration: docs/conf.py

diff --git a/docs/_static/css/ribbon.css b/docs/_static/css/ribbon.css
index 6008cb1..414332e 100644 (file)
--- a/docs/_static/css/ribbon.css
+++ b/docs/_static/css/ribbon.css
@@ -1,33 +1,33 @@
 .ribbon {
-  z-index: 1000;
-  background-color: #a00;
-  overflow: hidden;
-  white-space: nowrap;
-  position: fixed;
-  top: 25px;
-  right: -50px;
-  -webkit-transform: rotate(45deg);
-     -moz-transform: rotate(45deg);
-      -ms-transform: rotate(45deg);
-       -o-transform: rotate(45deg);
-          transform: rotate(45deg);
-  -webkit-box-shadow: 0 0 10px #888;
-     -moz-box-shadow: 0 0 10px #888;
-          box-shadow: 0 0 10px #888;
-
-}
-
-.ribbon a {
-  border: 1px solid #faa;
-  color: #fff;
-  display: block;
-  font: bold 81.25% 'Helvetica Neue', Helvetica, Arial, sans-serif;
-  margin: 1px 0;
-  padding: 10px 50px;
-  text-align: center;
-  text-decoration: none;
-  text-shadow: 0 0 5px #444;
-  transition: 0.5s;
+   z-index: 1000;
+   background-color: #a00;
+   overflow: hidden;
+   white-space: nowrap;
+   position: fixed;
+   top: 25px;
+   right: -50px;
+   -webkit-transform: rotate(45deg);
+      -moz-transform: rotate(45deg);
+       -ms-transform: rotate(45deg);
+        -o-transform: rotate(45deg);
+           transform: rotate(45deg);
+   -webkit-box-shadow: 0 0 10px #888;
+      -moz-box-shadow: 0 0 10px #888;
+           box-shadow: 0 0 10px #888;
+ 
+ }
+ 
+ .ribbon a {
+   border: 1px solid #faa;
+   color: #fff;
+   display: block;
+   font: bold 81.25% 'Helvetica Neue', Helvetica, Arial, sans-serif;
+   margin: 1px 0;
+   padding: 10px 50px;
+   text-align: center;
+   text-decoration: none;
+   text-shadow: 0 0 5px #444;
+   transition: 0.5s;
 }
 
 .ribbon a:hover {
@@ -59,5 +59,5 @@
 /* fix width of the screen */
 
 .wy-nav-content {
-    max-width: none;
+    max-width: 800px;
 }

diff --git a/docs/conf.py b/docs/conf.py
index 4b2fec5..c31b9f8 100644 (file)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -53,4 +53,4 @@ def setup(app):
 
 linkcheck_ignore = [
   r'http://localhost:\d+/'
-]
\ No newline at end of file
+]

diff --git a/docs/conf.yaml b/docs/conf.yaml
deleted file mode 100644 (file)
index ab59281..0000000
--- a/docs/conf.yaml
+++ /dev/null
@@ -1,7 +0,0 @@
----
-project_cfg: onap
-project: onap
-
-# Change this to ReleaseBranchName to modify the header
-default-version: latest
-#

diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt
new file mode 100644 (file)
index 0000000..71df2ab
--- /dev/null
+++ b/docs/requirements-docs.txt
@@ -0,0 +1,7 @@
+sphinx>=4.2.0  # BSD
+sphinx-rtd-theme>=1.0.0  # MIT
+sphinxcontrib-blockdiag  # BSD
+sphinxcontrib-seqdiag # BSD
+sphinxcontrib-swaggerdoc
+sphinxcontrib-spelling
+sphinxcontrib-plantuml

diff --git a/docs/tox.ini b/docs/tox.ini
new file mode 100644 (file)
index 0000000..6123bca
--- /dev/null
+++ b/docs/tox.ini
@@ -0,0 +1,31 @@
+[tox]
+minversion = 1.6
+envlist = docs,docs-linkcheck,docs-spellcheck
+skipsdist = true
+
+[testenv:docs]
+basepython = python3.8
+deps =
+    -r{toxinidir}/requirements-docs.txt
+    -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt
+    -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=kohn
+commands =
+    sphinx-build -W -q -b html -n -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/html
+
+[testenv:docs-linkcheck]
+basepython = python3.8
+deps =
+    -r{toxinidir}/requirements-docs.txt
+    -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt
+    -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=kohn
+commands =
+    sphinx-build -W -q -b linkcheck -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/linkcheck
+
+[testenv:docs-spellcheck]
+basepython = python3.8
+deps =
+    -r{toxinidir}/requirements-docs.txt
+    -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt
+    -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=kohn
+commands =
+    sphinx-build -W -q -b spelling -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/spellcheck
\ No newline at end of file

diff --git a/requirements.txt b/requirements.txt
deleted file mode 100644 (file)
index cc2d12c..0000000
--- a/requirements.txt
+++ /dev/null
@@ -1,6 +0,0 @@
-lfdocs-conf
-sphinx>=4.2.0  # BSD
-sphinx-rtd-theme>=1.0.0  # MIT
-autopep8
-sphinxcontrib-spelling
-pylint

diff --git a/tox.ini b/tox.ini
deleted file mode 100644 (file)
index 707c3d9..0000000
--- a/tox.ini
+++ /dev/null
@@ -1,79 +0,0 @@
-[tox]
-minversion = 1.6
-envlist = docs,docs-linkcheck
-skipsdist = true
-
-[testenv:docs]
-basepython = python3.8
-deps =
-    -r{toxinidir}/requirements.txt
-    -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt
-    -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt
-commands =
-    sphinx-build -W -q -b html -n -d {envtmpdir}/docs/doctrees {toxinidir}/docs {toxinidir}/docs/_build/html
-    echo "Generated docs available in {toxinidir}/docs/_build/html"
-whitelist_externals =
-    echo
-    git
-    sh
-
-[testenv:docs-templates]
-basepython = python3.8
-deps =
-    -r{toxinidir}/requirements.txt
-    -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt
-    -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt
-commands =
-    sphinx-build -b html -n -d {envtmpdir}/doctrees -c {toxinidir}/docs/ {toxinidir}/docs/guides/onap-developer/how-to-use-docs/templates {toxinidir}/_build/templates
-    echo "Generated docs available in {toxinidir}/_build/html/templates"
-whitelist_externals =
-    echo
-
-[testenv:local]
-basepython = python3.8
-deps =
-    -r{toxinidir}/requirements.txt
-    -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt
-    -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt
-commands =
-    git submodule update --depth 100 --init
-    sphinx-build -q -b html -n -d {envtmpdir}/doctrees {toxinidir}/docs {toxinidir}/docs/_build/html
-    echo "Generated docs available in {toxinidir}/docs/_build/html"
-whitelist_externals =
-    echo
-    git
-
-[testenv:docs-linkcheck]
-basepython = python3.8
-deps =
-    -r{toxinidir}/requirements.txt
-    -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt
-    -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt
-commands = sphinx-build -q -b linkcheck -d {envtmpdir}/doctrees {toxinidir}/docs {toxinidir}/docs/_build/linkcheck
-
-[testenv:spellcheck]
-basepython = python3.8
-deps =
-    -r{toxinidir}/requirements.txt
-    -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt
-    -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt
-commands =
-    sphinx-build -b spelling -Dextensions=sphinxcontrib.spelling -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/docs/_build/spellcheck
-
-[testenv:autopep8]
-basepython = python3.8
-deps =
-    -r{toxinidir}/requirements.txt
-    -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt
-    -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt
-commands =
-    autopep8 --max-line-length 120 --in-place {toxinidir}/docs/conf.py
-
-[testenv:pylint]
-basepython = python3.8
-deps =
-    -r{toxinidir}/requirements.txt
-    -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt
-    -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt
-commands =
-    pylint --max-line-length=120 --disable=missing-docstring --reports=y --score=y  --output-format=colorized {toxinidir}/docs/conf.py