diff options
author | Guangrong Fu <fu.guangrong@zte.com.cn> | 2021-10-14 09:14:31 +0800 |
---|---|---|
committer | Guangrong Fu <fu.guangrong@zte.com.cn> | 2021-10-14 09:27:07 +0800 |
commit | 6a35d99de3143d80f1fec13e310bb6fc156fe8cc (patch) | |
tree | d8f49e42e2ec4ef67b1fe1da95596e9b29d2e820 /docs/tox.ini | |
parent | 6e6587bdad31fb2575be2680419cc86125339a9d (diff) |
Updated docs
Issue-ID: HOLMES-480
Signed-off-by: Guangrong Fu <fu.guangrong@zte.com.cn>
Change-Id: I6893e4cd12dfd70e1c32079912cdfefad32b7da7
Diffstat (limited to 'docs/tox.ini')
-rw-r--r-- | docs/tox.ini | 71 |
1 files changed, 63 insertions, 8 deletions
diff --git a/docs/tox.ini b/docs/tox.ini index edac8c3..a538317 100644 --- a/docs/tox.ini +++ b/docs/tox.ini @@ -1,22 +1,77 @@ [tox] minversion = 1.6 -envlist = docs, +envlist = docs,docs-linkcheck skipsdist = true [testenv:docs] basepython = python3 -deps = -r{toxinidir}/requirements-docs.txt +deps = + -r{toxinidir}/etc/requirements.txt + -c{toxinidir}/etc/upper-constraints.os.txt + -c{toxinidir}/etc/upper-constraints.onap.txt commands = - sphinx-build -b html -n -d {envtmpdir}/doctrees ./ {toxinidir}/_build/html - echo "Generated docs available in {toxinidir}/_build/html" + 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.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.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}/requirements-docs.txt -commands = echo "Link Checking not enforced" -#commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./ {toxinidir}/_build/linkcheck -whitelist_externals = echo +deps = + -r{toxinidir}/etc/requirements.txt + -c{toxinidir}/etc/upper-constraints.os.txt + -c{toxinidir}/etc/upper-constraints.onap.txt +commands = sphinx-build -q -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck + +[testenv:spellcheck] +basepython = python3 +deps = + -r{toxinidir}/etc/requirements.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.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.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 |