From 14a4c9a40dfa6f15a9578cf11fcf169cb24857f6 Mon Sep 17 00:00:00 2001 From: Vijay Venkatesh Kumar Date: Tue, 1 Nov 2022 12:02:45 -0400 Subject: Doc config updates Change-Id: If02f4d94a9a95a54db926d4c6262df08b7582664 Issue-ID: DCAEGEN2-3301 (cherry picked from commit 958df7b5a982a8633135bcd8a42a5339cb5fc7b4) Signed-off-by: Vijay Venkatesh Kumar --- docs/tox.ini | 26 ++++++++++++++++++-------- 1 file changed, 18 insertions(+), 8 deletions(-) (limited to 'docs/tox.ini') diff --git a/docs/tox.ini b/docs/tox.ini index 64af58be..45ddfcb4 100644 --- a/docs/tox.ini +++ b/docs/tox.ini @@ -1,6 +1,6 @@ [tox] minversion = 1.6 -envlist = docs, +envlist = docs,docs-linkcheck,docs-spellcheck skipsdist = true [testenv:docs] @@ -8,21 +8,31 @@ basepython = python3.8 deps = -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 -commands = + -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=kohn +commands = sphinx-build -b html -n -d {envtmpdir}/doctrees ./ {toxinidir}/_build/html echo "Generated docs available in {toxinidir}/_build/html" +#commands = sphinx-build -W -q -b html -n -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/html + whitelist_externals = echo git sh - + [testenv:docs-linkcheck] basepython = python3.8 deps = -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 -commands = echo "Link Checking not enforced" -#commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./ {toxinidir}/_build/linkcheck -whitelist_externals = echo + -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=kohn +commands = echo "Link Checking not enforced" +#commands = sphinx-build -W -q -b linkcheck -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/linkcheck + +[testenv:docs-spellcheck] +basepython = python3.8 +deps = + -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=kohn +#commands = echo "Spell Check not enforced" +commands = sphinx-build -W -q -b spelling -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/spellcheck \ No newline at end of file -- cgit 1.2.3-korg