diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 00000000..77a05b30 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,19 @@ +# https://docs.readthedocs.io/en/stable/config-file/v2.html + +version: 2 + +build: + os: "ubuntu-lts-latest" + tools: + python: "3.11" + +python: + install: + - method: "pip" + path: "." + extra_requirements: + - "docs" + +sphinx: + configuration: "docs/conf.py" + fail_on_warning: true diff --git a/MANIFEST.in b/MANIFEST.in index 73e2e891..967a9c4f 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,4 +1,5 @@ include .pre-commit-config.yaml +include .readthedocs.yaml include CODE_OF_CONDUCT.md include AUTHORS.rst include CHANGELOG.rst diff --git a/tox.ini b/tox.ini index 606a9b6b..be5a4aa1 100644 --- a/tox.ini +++ b/tox.ini @@ -41,6 +41,7 @@ commands = {envpython} -b -m coverage run -m pytest {posargs} [testenv:docs] +# The tox config must match the ReadTheDocs config. basepython = python3.11 extras = docs commands =