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.
docs/requirements-docs.txt is renamed requirements.txt as it mixes
both docs and linter dependencies.
It removes tox and setuptools from requirements as nothing depends on them
(most requirements should be removed except lfdocsconf)
Issue-ID: DOC-765
Change-Id: Iae808297484f4798de82a43597ccad7905ff4c94
Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>
+++ /dev/null
-lfdocs-conf~=0.7.5
-funcparserlib~=1.0.0a0
-sphinxcontrib.blockdiag~=2.0.0
-sphinxcontrib-needs<0.6.0
-sphinxcontrib.plantuml~=0.21
-sphinxcontrib.nwdiag~=2.0.0
-sphinxcontrib-seqdiag~=2.0.0
-sphinxcontrib-swaggerdoc~=0.1.7
-sphinx-rtd-theme~=1.0.0
--- /dev/null
+Sphinx
+doc8
+docutils
+six
+lfdocs-conf
+sphinxcontrib-redoc
+sphinxcontrib-spelling
+PyEnchant
+pylint
+autopep8
+gitlint
ignore-path-errors=docs/helm-search.txt;D001
[testenv:doc8]
ignore-path-errors=docs/helm-search.txt;D001
[testenv:doc8]
-deps = -rdocs/requirements-docs.txt
- doc8
+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 =
- doc8 docs/
[testenv:docs]
commands =
- doc8 docs/
[testenv:docs]
-deps = -rdocs/requirements-docs.txt
+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 -W -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
[testenv:docs-linkcheck]
commands =
sphinx-build -q -W -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
[testenv:docs-linkcheck]
-deps = -rdocs/requirements-docs.txt
+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 -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck
[testenv:spelling]
#basepython = python3
whitelist_externals = wget
deps =
commands = sphinx-build -q -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck
[testenv:spelling]
#basepython = python3
whitelist_externals = wget
deps =
- -rdocs/requirements-docs.txt
- sphinxcontrib-spelling
- PyEnchant
+ -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
changedir={toxinidir}/docs
commands =
wget -nv https://git.onap.org/doc/plain/docs/spelling_wordlist.txt -O spelling_wordlist.txt
changedir={toxinidir}/docs
commands =
wget -nv https://git.onap.org/doc/plain/docs/spelling_wordlist.txt -O spelling_wordlist.txt
[testenv:gitlint]
basepython = python3
deps =
[testenv:gitlint]
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
find . -not -path '*/\.*' -name *.sh -exec checkbashisms \{\} +
[testenv:autopep8]
find . -not -path '*/\.*' -name *.sh -exec checkbashisms \{\} +
[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 --recursive kubernetes/ TOSCA/ docs/
[testenv:pylint]
commands =
autopep8 --max-line-length 120 --in-place --recursive kubernetes/ TOSCA/ docs/
[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
whitelist_externals = find
commands =
find kubernetes/ TOSCA/ docs/ -name *.py -exec pylint --max-line-length=120 --disable=missing-docstring --method-rgx="(([a-z_][a-zA-Z0-9_]{2,})|(_[a-z0-9_]*)|(__[a-zA-Z][a-zA-Z0-9_]+__))$" --variable-rgx="[a-zA-Z_][a-zA-Z0-9_]{1,30}$" --reports=y --score=y --output-format=colorized \{\} +
whitelist_externals = find
commands =
find kubernetes/ TOSCA/ docs/ -name *.py -exec pylint --max-line-length=120 --disable=missing-docstring --method-rgx="(([a-z_][a-zA-Z0-9_]{2,})|(_[a-z0-9_]*)|(__[a-zA-Z][a-zA-Z0-9_]+__))$" --variable-rgx="[a-zA-Z_][a-zA-Z0-9_]{1,30}$" --reports=y --score=y --output-format=colorized \{\} +