diff options
author | thmsdt <thomas.kulik@telekom.de> | 2022-08-16 13:10:56 +0200 |
---|---|---|
committer | thmsdt <thomas.kulik@telekom.de> | 2022-08-16 13:12:20 +0200 |
commit | 7e0db8a223e9d7a693c7120a5beb91df40fef82f (patch) | |
tree | ef5888d5f390d70d2332e0bdad9c1e2fad3e67b6 /examples/sphinx/release/tox.ini | |
parent | 65bec69096b0a2ef18cd72d87b89757da4ae1906 (diff) |
update sphinx example config files
Issue-ID: DOC-798
Signed-off-by: thmsdt <thomas.kulik@telekom.de>
Change-Id: I74a213993ada2b3697b58270c30c61326b151f7b
Diffstat (limited to 'examples/sphinx/release/tox.ini')
-rw-r--r-- | examples/sphinx/release/tox.ini | 77 |
1 files changed, 77 insertions, 0 deletions
diff --git a/examples/sphinx/release/tox.ini b/examples/sphinx/release/tox.ini new file mode 100644 index 000000000..6505b8512 --- /dev/null +++ b/examples/sphinx/release/tox.ini @@ -0,0 +1,77 @@ +[tox] +minversion = 1.6 +envlist = docs,docs-linkcheck +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 +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 + +[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 +commands = + sphinx-build -b spelling -Dextensions=sphinxcontrib.spelling -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/spellcheck + +[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] +deps = + -r{toxinidir}/etc/requirements-docs.txt + -c{toxinidir}/etc/upper-constraints.os.txt + -c{toxinidir}/etc/upper-constraints.onap.txt +commands = + pylint --max-line-length=120 --disable=missing-docstring --reports=y --score=y --output-format=colorized docs/conf.py |