Fix documentation configuration 97/112997/2
authorelinuxhenrik <henrik.b.andersson@est.tech>
Tue, 22 Sep 2020 13:48:10 +0000 (15:48 +0200)
committerelinuxhenrik <henrik.b.andersson@est.tech>
Tue, 22 Sep 2020 14:10:52 +0000 (16:10 +0200)
Change-Id: Icf6eaa2c951a04c15d457a1f51fa98661a226f2b
Issue-ID: CCSDK-2833
Signed-off-by: elinuxhenrik <henrik.b.andersson@est.tech>
.gitignore
docs/conf.py
docs/conf.yaml
docs/requirements-docs.txt [deleted file]
docs/tox.ini [deleted file]
tox.ini [new file with mode: 0644]

index d0cca38..e4d2870 100644 (file)
@@ -10,6 +10,7 @@ org.eclipse.core.resources.prefs
 .checkstyle
 maven-eclipse.xml
 workspace
+.pydevproject
 
 ## Compilation Files ##
 *.class
@@ -35,3 +36,4 @@ out/
 
 ## Documentation ignores ##
 .tox
+_build/
index 3c4453e..0339628 100644 (file)
@@ -1 +1,5 @@
 from docs_conf.conf import *
+
+#branch configuration
+
+branch = 'latest'
index aad3f82..5b6d55f 100644 (file)
@@ -1 +1,2 @@
 project_cfg: onap
+project: onap
\ No newline at end of file
diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt
deleted file mode 100644 (file)
index 74a3b7a..0000000
+++ /dev/null
@@ -1 +0,0 @@
-lfdocs-conf
diff --git a/docs/tox.ini b/docs/tox.ini
deleted file mode 100644 (file)
index edac8c3..0000000
+++ /dev/null
@@ -1,22 +0,0 @@
-[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
diff --git a/tox.ini b/tox.ini
new file mode 100644 (file)
index 0000000..32de8a6
--- /dev/null
+++ b/tox.ini
@@ -0,0 +1,32 @@
+[tox]
+minversion = 2.0
+envlist = docs,
+skipsdist = true
+
+[testenv:docs]
+basepython = python3
+deps = 
+    sphinx
+    sphinx-rtd-theme
+    sphinxcontrib-httpdomain
+    sphinxcontrib.blockdiag
+    sphinxcontrib.needs
+    sphinxcontrib.plantuml
+    sphinxcontrib.nwdiag
+    sphinxcontrib.seqdiag
+    sphinxcontrib.swaggerdoc
+    recommonmark
+    lfdocs-conf
+commands =
+    sphinx-build -b html -n -d {envtmpdir}/docs/doctrees ./docs/ {toxinidir}/docs/_build/html
+    echo "Generated docs available in {toxinidir}/docs/_build/html"
+whitelist_externals =
+    echo
+    git
+    sh
+
+[testenv:docs-linkcheck]
+basepython = python3
+commands = echo "Link Checking not enforced"
+#commands = sphinx-build -b linkcheck -d {envtmpdir}/docs/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck
+whitelist_externals = echo