diff options
| author |   Cédric Ollivier <cedric.ollivier@orange.com> | 2022-10-07 14:27:53 +0200 |
|---|---|---|
| committer | Cédric Ollivier <cedric.ollivier@orange.com> | 2022-10-07 14:29:38 +0200 |
| commit | 95de97305dd110a2624cca4c4fe748b8ce8e8493 (patch) | |
| tree | 999be16970a80b210d3bf0ebbd9b25f926209faf | |
| parent | 4facc3c25451d205b76e205f65522e410494583d (diff) | |
Slightly improve Doc's examples
Issue-ID: DOC-798
Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>
Change-Id: I541b3af46292bc1dbf8895c215747c0313b12eeb
| -rw-r--r-- | examples/sphinx/master/conf.py | 3 | ||||
| -rw-r--r-- | examples/sphinx/master/tox.ini | 4 | ||||
| -rw-r--r-- | examples/sphinx/release/conf.py | 3 | ||||
| -rw-r--r-- | examples/sphinx/release/tox.ini | 4 |
4 files changed, 8 insertions, 6 deletions
diff --git a/examples/sphinx/master/conf.py b/examples/sphinx/master/conf.py index d447769b9..e15eeeec4 100644 --- a/examples/sphinx/master/conf.py +++ b/examples/sphinx/master/conf.py @@ -18,7 +18,8 @@ html_show_sphinx = False extensions = [ 'sphinx.ext.intersphinx','sphinxcontrib.blockdiag', - 'sphinxcontrib.seqdiag', 'sphinxcontrib.swaggerdoc', 'sphinx.ext.graphviz'] + 'sphinxcontrib.seqdiag', 'sphinxcontrib.swaggerdoc', 'sphinx.ext.graphviz', + 'sphinxcontrib.spelling'] # # Map to 'latest' if this file is used in 'latest' (master) 'doc' branch. diff --git a/examples/sphinx/master/tox.ini b/examples/sphinx/master/tox.ini index 0c736590f..b9d7eb44b 100644 --- a/examples/sphinx/master/tox.ini +++ b/examples/sphinx/master/tox.ini @@ -19,7 +19,7 @@ deps = -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master commands = - sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/linkcheck + sphinx-build -W -q -b linkcheck -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/linkcheck [testenv:docs-spellcheck] basepython = python3.8 @@ -28,4 +28,4 @@ deps = -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master commands = - sphinx-build -W -b spelling -Dextensions=sphinxcontrib.spelling -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/spellcheck + sphinx-build -W -q -b spelling -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/spellcheck diff --git a/examples/sphinx/release/conf.py b/examples/sphinx/release/conf.py index f85f8991d..7976b6d51 100644 --- a/examples/sphinx/release/conf.py +++ b/examples/sphinx/release/conf.py @@ -18,7 +18,8 @@ html_show_sphinx = False extensions = [ 'sphinx.ext.intersphinx','sphinxcontrib.blockdiag', - 'sphinxcontrib.seqdiag', 'sphinxcontrib.swaggerdoc', 'sphinx.ext.graphviz'] + 'sphinxcontrib.seqdiag', 'sphinxcontrib.swaggerdoc', 'sphinx.ext.graphviz', + 'sphinxcontrib.spelling'] # # Map to 'latest' if this file is used in 'latest' (master) 'doc' branch. diff --git a/examples/sphinx/release/tox.ini b/examples/sphinx/release/tox.ini index 11c051a0d..4629c8313 100644 --- a/examples/sphinx/release/tox.ini +++ b/examples/sphinx/release/tox.ini @@ -19,7 +19,7 @@ deps = -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 -b linkcheck -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/linkcheck + sphinx-build -W -q -b linkcheck -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/linkcheck [testenv:docs-spellcheck] basepython = python3.8 @@ -28,4 +28,4 @@ deps = -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 -b spelling -Dextensions=sphinxcontrib.spelling -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/spellcheck + sphinx-build -W -q -b spelling -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/spellcheck |