X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=tox.ini;h=f6d1800d56ed6b6a630be080f4a8515daf9801a3;hb=refs%2Fchanges%2F64%2F1664%2F3;hp=70389b6ff8c669360c74dd89d4bf2e031f4980bc;hpb=a84245aac0d02537bdff0e79b872d47ef3bd4593;p=ric-plt%2Fa1.git

diff --git a/tox.ini b/tox.ini
index 70389b6..f6d1800 100644
--- a/tox.ini
+++ b/tox.ini
@@ -15,7 +15,8 @@
 #   limitations under the License.
 # ==================================================================================
 [tox]
-envlist = py37,flake8
+envlist = py37,flake8,docs,docs-linkcheck
+minversion = 2.0
 
 [testenv]
 deps=
@@ -29,6 +30,7 @@ setenv =
 
 # Note, before this will work, for the first time on that machine, run ./install_deps.sh
 commands =
+# sometimes the -s flag is helpful; add -s after pytest; which streams the logs as they come in, rather than saving them all for the end of tests
     pytest --junitxml xunit-results.xml --cov a1 --cov-report xml --cov-report term-missing --cov-report html --cov-fail-under=70
     coverage xml -i
 
@@ -40,3 +42,27 @@ commands = flake8 setup.py a1 tests
 
 [flake8]
 extend-ignore = E501,E741
+
+# 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
+
+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