RIC:1060: Change in PTL

[ric-plt/a1.git] / tox.ini

diff --git a/tox.ini b/tox.ini
index 976ddc7..bb6c9de 100644 (file)
--- a/tox.ini
+++ b/tox.ini
@@ -1,40 +1,55 @@
-# ==================================================================================
-#       Copyright (c) 2019 Nokia
-#       Copyright (c) 2018-2019 AT&T Intellectual Property.
-#
-#   Licensed under the Apache License, Version 2.0 (the "License");
-#   you may not use this file except in compliance with the License.
-#   You may obtain a copy of the License at
-#
-#          http://www.apache.org/licenses/LICENSE-2.0
-#
-#   Unless required by applicable law or agreed to in writing, software
-#   distributed under the License is distributed on an "AS IS" BASIS,
-#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#   See the License for the specific language governing permissions and
-#   limitations under the License.
-# ==================================================================================
+#==================================================================================
+#    Copyright (c) 2022 Samsung
+
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+
+#    #http://www.apache.org/licenses/LICENSE-2.0
+
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+
+#    This source code is part of the near-RT RIC (RAN Intelligent Controller)
+#    platform project (RICP).
+#==================================================================================
+
+
+# Docs
 [tox]
-envlist = py37,flake8
-
-[testenv]
-deps=
-    pytest
-    coverage
-    pytest-cov
-setenv =
-    LD_LIBRARY_PATH = /usr/local/lib/
-    RMR_RCV_RETRY_INTERVAL = 1
-    RMR_RETRY_TIMES = 2
-commands=
-# Note, before this will work, for the first time on that machine, run ./install_deps.sh
-    pytest --verbose --cov {envsitepackagesdir}/a1  --cov-report html
-
-[testenv:flake8]
-basepython = python3.7
-skip_install = true
-deps = flake8
-commands = flake8 setup.py a1 tests
-
-[flake8]
-extend-ignore = E501
+minversion = 2.0
+envlist =
+    docs,
+    docs-linkcheck,
+
+skipsdist = true
+
+
+# verbatim as asked for by the docs instructions: https://wiki.o-ran-sc.org/display/DOC/Configure+Repo+for+Documentation
+[testenv:docs]
+basepython = python3
+deps =
+    sphinx
+    sphinx-rtd-theme
+    sphinxcontrib-httpdomain
+    recommonmark
+    lfdocs-conf
+    urllib3~=1.26.15
+
+commands =
+    sphinx-build -W -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
+    echo "Generated docs available in {toxinidir}/docs/_build/html"
+allowlist_externals = echo
+
+[testenv:docs-linkcheck]
+basepython = python3
+deps = sphinx
+       sphinx-rtd-theme
+       sphinxcontrib-httpdomain
+       recommonmark
+       lfdocs-conf
+       urllib3~=1.26.15
+commands = sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck