Add documentation in the required format.
Also twiddles the tox to name the code job so that the verify job can be
changed to not run docs.
Issue-ID: RIC-228
Change-Id: I5ded9ae6d421f0906f9fb544ee78dfbf9e8f4291
Signed-off-by: Tommy Carpenter <tc677g@att.com>
diff --git a/tox.ini b/tox.ini
index c7fd69a..43a8d34 100644
--- a/tox.ini
+++ b/tox.ini
@@ -15,11 +15,10 @@
# limitations under the License.
# ==================================================================================
[tox]
-envlist = py37,flake8
-# ,docs,docs-linkcheck
+envlist = code,flake8,docs,docs-linkcheck
minversion = 2.0
-[testenv]
+[testenv:code]
basepython = python3.7
deps=
pytest
@@ -27,7 +26,6 @@
pytest-cov
setenv =
LD_LIBRARY_PATH = /usr/local/lib/:/usr/local/lib64
-
commands =
pytest --junitxml xunit-results.xml --cov ricxappframe --cov-report xml --cov-report term-missing --cov-report html --cov-fail-under=50
coverage xml -i
@@ -41,26 +39,27 @@
[flake8]
extend-ignore = E501,E741,E731
-# verbatim as asked for by the docs instructions: https://wiki.o-ran-sc.org/display/DOC/Configure+Repo+for+Documentation
-# [testenv:docs]
-# basepython = python3.7
-# deps =
-# sphinx
-# sphinx-rtd-theme
-# sphinxcontrib-httpdomain
-# recommonmark
-# lfdocs-conf
+# doc jobs
+[testenv:docs]
+whitelist_externals = echo
+skipsdist = true
+basepython = python3.7
+deps =
+ sphinx
+ sphinx-rtd-theme
+ sphinxcontrib-httpdomain
+ recommonmark
+ lfdocs-conf
+commands =
+ sphinx-build -W -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
+ echo "Generated docs available in {toxinidir}/docs/_build/html"
-#commands =
-# sphinx-build -W -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
-# echo "Generated docs available in {toxinidir}/docs/_build/html"
-#whitelist_externals = echo
-
-#[testenv:docs-linkcheck]
-#basepython = python3.7
-#deps = sphinx
-# sphinx-rtd-theme
-# sphinxcontrib-httpdomain
-# recommonmark
-# lfdocs-conf
-#commands = sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck
+[testenv:docs-linkcheck]
+skipsdist = true
+basepython = python3.7
+deps = sphinx
+ sphinx-rtd-theme
+ sphinxcontrib-httpdomain
+ recommonmark
+ lfdocs-conf
+commands = sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck