Follow docs instructions.
[ric-plt/a1.git] / tox.ini
1 # ==================================================================================
2 #       Copyright (c) 2019 Nokia
3 #       Copyright (c) 2018-2019 AT&T Intellectual Property.
4 #
5 #   Licensed under the Apache License, Version 2.0 (the "License");
6 #   you may not use this file except in compliance with the License.
7 #   You may obtain a copy of the License at
8 #
9 #          http://www.apache.org/licenses/LICENSE-2.0
10 #
11 #   Unless required by applicable law or agreed to in writing, software
12 #   distributed under the License is distributed on an "AS IS" BASIS,
13 #   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 #   See the License for the specific language governing permissions and
15 #   limitations under the License.
16 # ==================================================================================
17 [tox]
18 envlist = py37,flake8,docs,docs-linkcheck
19 minversion = 2.0
20
21 [testenv]
22 deps=
23     pytest
24     coverage
25     pytest-cov
26 setenv =
27     LD_LIBRARY_PATH = /usr/local/lib/:/usr/local/lib64
28     RMR_RCV_RETRY_INTERVAL = 1
29     RMR_RETRY_TIMES = 2
30
31 # Note, before this will work, for the first time on that machine, run ./install_deps.sh
32 commands =
33 # 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
34     pytest --junitxml xunit-results.xml --cov a1 --cov-report xml --cov-report term-missing --cov-report html --cov-fail-under=70
35     coverage xml -i
36
37 [testenv:flake8]
38 basepython = python3.7
39 skip_install = true
40 deps = flake8
41 commands = flake8 setup.py a1 tests
42
43 [flake8]
44 extend-ignore = E501,E741
45
46 # verbatim as asked for by the docs instructions: https://wiki.o-ran-sc.org/display/DOC/Configure+Repo+for+Documentation
47 [testenv:docs]
48 basepython = python3.7
49 deps =
50     sphinx
51     sphinx-rtd-theme
52     sphinxcontrib-httpdomain
53     recommonmark
54     lfdocs-conf
55
56 commands =
57     sphinx-build -W -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
58     echo "Generated docs available in {toxinidir}/docs/_build/html"
59 whitelist_externals = echo
60
61 [testenv:docs-linkcheck]
62 basepython = python3.7
63 deps = sphinx
64        sphinx-rtd-theme
65        sphinxcontrib-httpdomain
66        recommonmark
67        lfdocs-conf
68 commands = sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck