summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorGuillaume Lambert <guillaume.lambert@orange.com>2021-02-02 15:48:14 +0100
committerGuillaume Lambert <guillaume.lambert@orange.com>2021-02-02 15:58:34 +0100
commit406a9c94549c014fab8d777a788832f3a9197703 (patch)
treeb512ef7b1ba7d712d69245fc9dae740f1dc48cc9 /docs
parentfaffc27b609a194af9277ec247291ae86e4817c3 (diff)
[DOC] Remove tox.ini doppelganger
in docs folder - same profiles are declared in tox.ini. They can be calld from the docs folder without it. - 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. Issue-ID: DOC-692 Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com> Change-Id: I473ae1193c1e5b124c8532a1b8185f01c67c70de
Diffstat (limited to 'docs')
-rw-r--r--docs/tox.ini44
1 files changed, 0 insertions, 44 deletions
diff --git a/docs/tox.ini b/docs/tox.ini
deleted file mode 100644
index 9d8bf531a..000000000
--- a/docs/tox.ini
+++ /dev/null
@@ -1,44 +0,0 @@
-[tox]
-minversion = 1.6
-envlist = docs,
-# docs-linkcheck,
-
-skipsdist = true
-
-[testenv:docs]
-basepython = python3
-deps = -r{toxinidir}/../etc/requirements.txt
-commands =
- sphinx-build -b html -n -d {envtmpdir}/doctrees ./ {toxinidir}/_build/html
- echo "Generated docs available in {toxinidir}/docs/_build/html"
-whitelist_externals =
- echo
- git
- sh
-
-[testenv:local]
-basepython = python3
-deps = -r{toxinidir}/../etc/requirements.txt
-commands =
- git submodule update --depth 100 --init
- sphinx-build -b html -n -d {envtmpdir}/doctrees ./ {toxinidir}/_build/html
- echo "Generated docs available in {toxinidir}/_build/html"
-whitelist_externals =
- echo
- git
-
-[testenv:docs-linkcheck]
-basepython = python3
-deps = -r{toxinidir}/../etc/requirements.txt
-commands = echo "Link Checking not enforced"
-#commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck
-whitelist_externals =
- echo
-
-[testenv:spellcheck]
-basepython = python3
-deps =
- -r{toxinidir}/../etc/requirements.txt
- sphinxcontrib-spelling
-commands =
- sphinx-build -b spelling -Dextensions=sphinxcontrib.spelling -Dspelling_word_list_filename=validwords.txt -d {envtmpdir}/doctrees ./ {toxinidir}/_build/spellcheck