From d242150035c5aa0a0d7ab3e020b75ab5d89bde63 Mon Sep 17 00:00:00 2001 From: Cédric Ollivier Date: Tue, 28 Sep 2021 16:26:56 +0200 Subject: [COMMON] Adds 2 upper-constraints files to pin all dependencies MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 --- docs/requirements-docs.txt | 9 --------- requirements.txt | 11 +++++++++++ tox.ini | 37 ++++++++++++++++++++++++++----------- 3 files changed, 37 insertions(+), 20 deletions(-) delete mode 100644 docs/requirements-docs.txt create mode 100644 requirements.txt diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt deleted file mode 100644 index edffc4b5d7..0000000000 --- a/docs/requirements-docs.txt +++ /dev/null @@ -1,9 +0,0 @@ -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 diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000000..f3d82daf4a --- /dev/null +++ b/requirements.txt @@ -0,0 +1,11 @@ +Sphinx +doc8 +docutils +six +lfdocs-conf +sphinxcontrib-redoc +sphinxcontrib-spelling +PyEnchant +pylint +autopep8 +gitlint diff --git a/tox.ini b/tox.ini index efe3b38035..bbd00f85c4 100644 --- a/tox.ini +++ b/tox.ini @@ -12,27 +12,35 @@ skipsdist=true 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] -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] -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 = - -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 @@ -41,8 +49,9 @@ commands = [testenv:gitlint] basepython = python3 deps = - gitlint - + -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 = gitlint @@ -58,12 +67,18 @@ commands = find . -not -path '*/\.*' -name *.sh -exec checkbashisms \{\} + [testenv:autopep8] -deps = 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] -deps = 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 \{\} + -- cgit 1.2.3-korg