aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorelinuxhenrik <henrik.b.andersson@est.tech>2020-09-22 15:48:10 +0200
committerelinuxhenrik <henrik.b.andersson@est.tech>2020-09-22 16:10:52 +0200
commit3d854201317ddcffcdb6bb633632869e90759555 (patch)
tree379a834e9460b339396c1b7879c470d2ce0f6f42
parentc9a39477a2deaa87393be7db8f3895a707c9a33d (diff)
Fix documentation configuration
Change-Id: Icf6eaa2c951a04c15d457a1f51fa98661a226f2b Issue-ID: CCSDK-2833 Signed-off-by: elinuxhenrik <henrik.b.andersson@est.tech>
-rw-r--r--.gitignore2
-rw-r--r--docs/conf.py4
-rw-r--r--docs/conf.yaml1
-rw-r--r--docs/requirements-docs.txt1
-rw-r--r--docs/tox.ini22
-rw-r--r--tox.ini32
6 files changed, 39 insertions, 23 deletions
diff --git a/.gitignore b/.gitignore
index d0cca389..e4d28704 100644
--- a/.gitignore
+++ b/.gitignore
@@ -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/
diff --git a/docs/conf.py b/docs/conf.py
index 3c4453e7..0339628f 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -1 +1,5 @@
from docs_conf.conf import *
+
+#branch configuration
+
+branch = 'latest'
diff --git a/docs/conf.yaml b/docs/conf.yaml
index aad3f822..5b6d55fe 100644
--- a/docs/conf.yaml
+++ b/docs/conf.yaml
@@ -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
index 74a3b7a3..00000000
--- a/docs/requirements-docs.txt
+++ /dev/null
@@ -1 +0,0 @@
-lfdocs-conf
diff --git a/docs/tox.ini b/docs/tox.ini
deleted file mode 100644
index edac8c35..00000000
--- a/docs/tox.ini
+++ /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
index 00000000..32de8a6c
--- /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