-# 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
[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"
[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
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