diff options
| author |   Aric Gardner <agardner@linuxfoundation.org> | 2020-02-05 14:58:31 -0500 |
|---|---|---|
| committer | Aric Gardner <agardner@linuxfoundation.org> | 2020-02-05 15:00:25 -0500 |
| commit | f1f16c00897d13a2c18830618f0e060855fb01f1 (patch) | |
| tree | 5dfa7ed69d4b815a5e4cc4b466463dc836dc4882 | |
| parent | dd7413d2458ad83166690f11690d8fc1dfed8b60 (diff) | |
modify readthedocs.yaml
Now that the yaml file is actually being read
we need to tell read the docs to do the submodule dance.
also, I added another tox.ini
in the docs dir, this is for rtdv3 builds
the one in root will be removed once we are
ready to retire the old method of docs building
Issue-ID: CIMAN-33
Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
Change-Id: I5e4866c5a1d68a16d8d027f8c4ec7397ea3d3c59
| -rw-r--r-- | .readthedocs.yaml | 3 | ||||
| -rw-r--r-- | docs/tox.ini | 44 |
2 files changed, 47 insertions, 0 deletions
diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 55bc765b1..f35ca0461 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -17,5 +17,8 @@ python: install: - requirements: etc/requirements.txt +submodules: + include: all + sphinx: configuration: docs/conf.py diff --git a/docs/tox.ini b/docs/tox.ini new file mode 100644 index 000000000..9d8bf531a --- /dev/null +++ b/docs/tox.ini @@ -0,0 +1,44 @@ +[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 |