diff options
| author |   Aric Gardner <agardner@linuxfoundation.org> | 2020-02-05 13:15:34 -0500 |
|---|---|---|
| committer | Aric Gardner <agardner@linuxfoundation.org> | 2020-02-05 13:41:46 -0500 |
| commit | dd7413d2458ad83166690f11690d8fc1dfed8b60 (patch) | |
| tree | 01649452e769322b7f31ccffab508e408fcb0866 | |
| parent | 57012dc4573eae02a22257e2dd9553a132e97b46 (diff) | |
Fix readthedocs.yml
Also fix conf.py lint errors
etc/requirements.txt is hardcoded in rtd config
to support older builds I cannot change it
untill the next release
Issue-ID: CIMAN-33
Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
Change-Id: I27f1dcf32d226ea094b20ad275b318d07fa9648b
| -rw-r--r-- | .readthedocs.yaml | 20 | ||||
| -rw-r--r-- | etc/requirements.txt (renamed from docs/requirements-docs.txt) | 0 | ||||
| -rw-r--r-- | tox.ini | 15 |
3 files changed, 22 insertions, 13 deletions
diff --git a/.readthedocs.yaml b/.readthedocs.yaml index f9b33a141..55bc765b1 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -1,17 +1,21 @@ -# Formats in addition to HTML +--- +# .readthedocs.yml +# # Read the Docs configuration file +# # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details +# # Required +# +version: 2 formats: - htmlzip -python: - version: 3.7 - install: - - requirements: docs/requirements-docs.txt - -# Build Container build: image: latest +python: + version: 3.7 + install: + - requirements: etc/requirements.txt sphinx: - configuration: docs/conf.py + configuration: docs/conf.py diff --git a/docs/requirements-docs.txt b/etc/requirements.txt index b3188ddd3..b3188ddd3 100644 --- a/docs/requirements-docs.txt +++ b/etc/requirements.txt @@ -1,11 +1,13 @@ [tox] minversion = 1.6 -envlist = docs +envlist = docs, +# docs-linkcheck, + skipsdist = true [testenv:docs] basepython = python3 -deps = -r{toxinidir}/docs/requirements-docs.txt +deps = -r{toxinidir}/etc/requirements.txt commands = sphinx-build -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html echo "Generated docs available in {toxinidir}/docs/_build/html" @@ -16,7 +18,7 @@ whitelist_externals = [testenv:local] basepython = python3 -deps = -r{toxinidir}/docs/requirements-docs.txt +deps = -r{toxinidir}/etc/requirements.txt commands = git submodule update --depth 100 --init sphinx-build -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html @@ -25,10 +27,13 @@ whitelist_externals = echo git -[testenv:linkcheck] +[testenv:docs-linkcheck] basepython = python3 deps = -r{toxinidir}/etc/requirements.txt -commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck +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 |