diff options
| author |   Guillaume Lambert <guillaume.lambert@orange.com> | 2021-02-02 10:51:46 +0100 |
|---|---|---|
| committer | Guillaume Lambert <guillaume.lambert@orange.com> | 2021-02-02 11:41:50 +0100 |
| commit | facc2a95ae4f4b61698235fdb9e08db89f64c43e (patch) | |
| tree | 5db0e8873687d4cf9d8959604695f046ac784bfa | |
| parent | a92e91d641305c96ccfea06d0c5e9c0d8f4c0fcc (diff) | |
[COMMON] Fix tox docs profiles configuration
- sphinx-build '-W' option needed only once
- remove docs/tox.ini since
* same profiles are declared in tox.ini
* once run from the docs folder, this generates invalid files
in doc/.tox for linters setup (e.g. docs/.tox/[..]/invalid.rst).
They can cause warnings treated as errors by root tox profiles.
- modify requirements.txt to force a sphinxcontrib-needs version prior
to 0.6.0 . This latest version introduces a new services support
functionality that cannot be easily disabled here and that requires
additional configuration parameters to link GitHub issues.
We cannot provide these parameters since this project uses JIRA.
As a result, sphinx generates a warning treated as an error
that makes the gate fail.
https://sphinxcontrib-needs.readthedocs.io/en/service/services/index.html
Issue-ID: OOM-2648
Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: I14e9045482750f15a3e5e98af47197e2c9f60f60
| -rw-r--r-- | docs/requirements-docs.txt | 2 | ||||
| -rw-r--r-- | docs/tox.ini | 22 | ||||
| -rw-r--r-- | tox.ini | 2 |
3 files changed, 2 insertions, 24 deletions
diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt index e14c784ee4..1c1895acf6 100644 --- a/docs/requirements-docs.txt +++ b/docs/requirements-docs.txt @@ -6,7 +6,7 @@ setuptools six sphinx_rtd_theme>=0.4.3 sphinxcontrib-blockdiag -sphinxcontrib-needs>=0.2.3 +sphinxcontrib-needs<0.6.0 sphinxcontrib-nwdiag sphinxcontrib-redoc sphinxcontrib-seqdiag diff --git a/docs/tox.ini b/docs/tox.ini deleted file mode 100644 index edac8c35fc..0000000000 --- a/docs/tox.ini +++ /dev/null @@ -1,22 +0,0 @@ -[tox] -minversion = 1.6 -envlist = docs, -skipsdist = true - -[testenv:docs] -basepython = python3 -deps = -r{toxinidir}/requirements-docs.txt -commands = - sphinx-build -b html -n -d {envtmpdir}/doctrees ./ {toxinidir}/_build/html - echo "Generated docs available in {toxinidir}/_build/html" -whitelist_externals = - echo - git - sh - -[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 @@ -17,7 +17,7 @@ commands = [testenv:docs] deps = -rdocs/requirements-docs.txt commands = - sphinx-build -W -b html -n -W -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html + sphinx-build -W -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html [testenv:docs-linkcheck] deps = -rdocs/requirements-docs.txt |