summaryrefslogtreecommitdiffstats
path: root/tox.ini
diff options
context:
space:
mode:
authorCédric Ollivier <cedric.ollivier@orange.com>2021-10-21 17:58:01 +0200
committerCédric Ollivier <cedric.ollivier@orange.com>2021-10-27 02:34:14 +0200
commit3c0ce0f85b34392dd50608e7440f10a20b0279cd (patch)
tree92521c605d2880a2a0dfabad5cdcaa7c48e89c4b /tox.ini
parent6a35d99de3143d80f1fec13e310bb6fc156fe8cc (diff)
Leverage upper-constraints files to pin all dependencies
It leverages the latest change from lfdocs-conf and the upper-constraints.txt now centralized in ONAP docs. In a long run, upperconstraints.os.txt should be removed once ONAP is synced with OpenStack. It removes tox and setuptools from requirements as nothing depends on them (most requirements should be removed except lfdocsconf) Issue-ID: DOC-765 Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com> Change-Id: I893490b8dfe244e49912d599b8b40745e546862c
Diffstat (limited to 'tox.ini')
-rw-r--r--tox.ini77
1 files changed, 77 insertions, 0 deletions
diff --git a/tox.ini b/tox.ini
new file mode 100644
index 0000000..fdb8ea8
--- /dev/null
+++ b/tox.ini
@@ -0,0 +1,77 @@
+[tox]
+minversion = 1.6
+envlist = docs,docs-linkcheck
+skipsdist = true
+
+[testenv:docs]
+basepython = python3
+deps =
+ -r{toxinidir}/requirements.txt
+ -chttps://git.onap.org/doc/plain/etc/upper-constraints.os.txt
+ -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt
+commands =
+ sphinx-build -W -q -b html -n -d {envtmpdir}/docs/doctrees {toxinidir}/docs {toxinidir}/docs/_build/html
+ echo "Generated docs available in {toxinidir}/docs/_build/html"
+whitelist_externals =
+ echo
+ git
+ sh
+
+[testenv:docs-templates]
+basepython = python3
+deps =
+ -r{toxinidir}/requirements.txt
+ -chttps://git.onap.org/doc/plain/etc/upper-constraints.os.txt
+ -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt
+commands =
+ sphinx-build -b html -n -d {envtmpdir}/doctrees -c {toxinidir}/docs/ {toxinidir}/docs/guides/onap-developer/how-to-use-docs/templates {toxinidir}/_build/templates
+ echo "Generated docs available in {toxinidir}/_build/html/templates"
+whitelist_externals =
+ echo
+
+[testenv:local]
+basepython = python3
+deps =
+ -r{toxinidir}/requirements.txt
+ -chttps://git.onap.org/doc/plain/etc/upper-constraints.os.txt
+ -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt
+commands =
+ git submodule update --depth 100 --init
+ sphinx-build -q -b html -n -d {envtmpdir}/doctrees {toxinidir}/docs {toxinidir}/docs/_build/html
+ echo "Generated docs available in {toxinidir}/docs/_build/html"
+whitelist_externals =
+ echo
+ git
+
+[testenv:docs-linkcheck]
+basepython = python3
+deps =
+ -r{toxinidir}/requirements.txt
+ -chttps://git.onap.org/doc/plain/etc/upper-constraints.os.txt
+ -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt
+commands = sphinx-build -q -b linkcheck -d {envtmpdir}/doctrees {toxinidir}/docs {toxinidir}/docs/_build/linkcheck
+
+[testenv:spellcheck]
+basepython = python3
+deps =
+ -r{toxinidir}/requirements.txt
+ -chttps://git.onap.org/doc/plain/etc/upper-constraints.os.txt
+ -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt
+commands =
+ sphinx-build -b spelling -Dextensions=sphinxcontrib.spelling -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/docs/_build/spellcheck
+
+[testenv:autopep8]
+deps =
+ -r{toxinidir}/requirements.txt
+ -chttps://git.onap.org/doc/plain/etc/upper-constraints.os.txt
+ -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt
+commands =
+ autopep8 --max-line-length 120 --in-place {toxinidir}/docs/conf.py
+
+[testenv:pylint]
+deps =
+ -r{toxinidir}/requirements.txt
+ -chttps://git.onap.org/doc/plain/etc/upper-constraints.os.txt
+ -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt
+commands =
+ pylint --max-line-length=120 --disable=missing-docstring --reports=y --score=y --output-format=colorized {toxinidir}/docs/conf.py