Add a trivial doc change to bronze branch
[ric-plt/xapp-frame-py.git] / tox.ini
1 # ==================================================================================
2 #       Copyright (c) 2020 Nokia
3 #       Copyright (c) 2020 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 = code,flake8,docs,docs-linkcheck
19 minversion = 2.0
20
21 [testenv:code]
22 basepython = python3.8
23 deps=
24     pytest
25     coverage
26     pytest-cov
27 setenv =
28     LD_LIBRARY_PATH = /usr/local/lib/:/usr/local/lib64
29     RMR_SEED_RT = tests/fixtures/test_local.rt
30     RMR_ASYNC_CONN = 0
31
32 commands =
33     # add the -s flag after pytest to show the logs immediately when they arrive instead of delaying.
34     pytest --cov ricxappframe --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.8
39 skip_install = true
40 deps = flake8
41 commands = flake8 setup.py ricxappframe tests
42
43 [flake8]
44 extend-ignore = E501,E741,E731
45
46 [testenv:clm]
47 # use pip to gather dependencies with versions for CLM analysis
48 whitelist_externals = sh
49 commands = sh -c 'pip freeze > requirements.txt'
50
51 # doc jobs
52 [testenv:docs]
53 whitelist_externals = echo
54 skipsdist = true
55 basepython = python3.8
56 setenv =
57     LD_LIBRARY_PATH = /usr/local/lib/:/usr/local/lib64
58 deps =
59     sphinx
60     sphinx-rtd-theme
61     sphinxcontrib-httpdomain
62     recommonmark
63     lfdocs-conf
64     numpydoc
65 commands =
66     sphinx-build -W -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
67     echo "Generated docs available in {toxinidir}/docs/_build/html"
68
69 [testenv:docs-linkcheck]
70 skipsdist = true
71 basepython = python3.8
72 setenv =
73     LD_LIBRARY_PATH = /usr/local/lib/:/usr/local/lib64
74 deps = sphinx
75        sphinx-rtd-theme
76        sphinxcontrib-httpdomain
77        recommonmark
78        lfdocs-conf
79        numpydoc
80 commands = sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck