summaryrefslogtreecommitdiffstats
path: root/examples/sphinx/release/tox.ini
diff options
context:
space:
mode:
authorCédric Ollivier <cedric.ollivier@orange.com>2022-08-22 15:53:00 +0200
committerCédric Ollivier <cedric.ollivier@orange.com>2022-08-23 10:25:50 +0200
commitbcba18a222a8bcf8d937a60436574426306dadae (patch)
tree9b30310a78e8cdbe23608b66b6765639d843efe6 /examples/sphinx/release/tox.ini
parentc5123d6d7f9b5d7f5a0d3de143b778b291dbbb08 (diff)
Use official OpenStack Yoga upper constraints
As they remove sphinx from the list, we can switch to the official files. etc/upper-constraints.os.txt will be removed once all ONAP part of doc's conf.py are updated. It also fixes master's and releases's tox.ini and modifies conf.py to make spellcheck work. It syncs release/_static/css/ribbon.css which was obsolete. Issue-ID: DOC-782 Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com> Change-Id: I22757e2d6750e88ac7e83a0636fc0755976a2cbd
Diffstat (limited to 'examples/sphinx/release/tox.ini')
-rw-r--r--examples/sphinx/release/tox.ini76
1 files changed, 15 insertions, 61 deletions
diff --git a/examples/sphinx/release/tox.ini b/examples/sphinx/release/tox.ini
index 6505b8512..87f60aa2d 100644
--- a/examples/sphinx/release/tox.ini
+++ b/examples/sphinx/release/tox.ini
@@ -1,77 +1,31 @@
[tox]
minversion = 1.6
-envlist = docs,docs-linkcheck
+envlist = docs,docs-linkcheck,docs-spellcheck
skipsdist = true
[testenv:docs]
basepython = python3
deps =
- -r{toxinidir}/etc/requirements-docs.txt
- -c{toxinidir}/etc/upper-constraints.os.txt
- -c{toxinidir}/etc/upper-constraints.onap.txt
+ -r{toxinidir}/requirements-docs.txt
+ -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt
+ -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h={release}
commands =
- sphinx-build -W -q -b html -n -d {envtmpdir}/doctrees ./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}/etc/requirements-docs.txt
- -c{toxinidir}/etc/upper-constraints.os.txt
- -c{toxinidir}/etc/upper-constraints.onap.txt
-commands =
- sphinx-build -b html -n -d {envtmpdir}/doctrees -c {toxinidir}/docs ./docs/guides/onap-developer/how-to-use-docs/templates {toxinidir}/docs/_build/html/templates
- echo "Generated docs available in {toxinidir}/docs/_build/html/templates"
-whitelist_externals =
- echo
-
-[testenv:local]
-basepython = python3
-deps =
- -r{toxinidir}/etc/requirements-docs.txt
- -c{toxinidir}/etc/upper-constraints.os.txt
- -c{toxinidir}/etc/upper-constraints.onap.txt
-commands =
- git submodule update --depth 100 --init
- sphinx-build -q -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
- echo "Generated docs available in {toxinidir}/docs/_build/html"
-whitelist_externals =
- echo
- git
+ sphinx-build -W -q -b html -n -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/html
[testenv:docs-linkcheck]
basepython = python3
deps =
- -r{toxinidir}/etc/requirements-docs.txt
- -c{toxinidir}/etc/upper-constraints.os.txt
- -c{toxinidir}/etc/upper-constraints.onap.txt
-commands = sphinx-build -W -q -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck
-
-[testenv:spellcheck]
-basepython = python3
-deps =
- -r{toxinidir}/etc/requirements-docs.txt
- -c{toxinidir}/etc/upper-constraints.os.txt
- -c{toxinidir}/etc/upper-constraints.onap.txt
+ -r{toxinidir}/requirements-docs.txt
+ -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt
+ -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h={release}
commands =
- sphinx-build -b spelling -Dextensions=sphinxcontrib.spelling -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/spellcheck
+ sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/linkcheck
-[testenv:autopep8]
-deps =
- -r{toxinidir}/etc/requirements-docs.txt
- -c{toxinidir}/etc/upper-constraints.os.txt
- -c{toxinidir}/etc/upper-constraints.onap.txt
-commands =
- autopep8 --max-line-length 120 --in-place docs/conf.py
-
-[testenv:pylint]
+[testenv:docs-spellcheck]
+basepython = python3
deps =
- -r{toxinidir}/etc/requirements-docs.txt
- -c{toxinidir}/etc/upper-constraints.os.txt
- -c{toxinidir}/etc/upper-constraints.onap.txt
+ -r{toxinidir}/requirements-docs.txt
+ -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt
+ -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h={release}
commands =
- pylint --max-line-length=120 --disable=missing-docstring --reports=y --score=y --output-format=colorized docs/conf.py
+ sphinx-build -W -b spelling -Dextensions=sphinxcontrib.spelling -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/spellcheck