Provide ReadTheDocs configuration (#275) (#240)

RTD has been requiring a configuration file for a while, this change
should resolve the currently ongoing documentation build failures.
This commit is contained in:
Jakub Stasiak 2023-12-13 22:48:09 +01:00 committed by GitHub
parent 82929b6eca
commit c7d1f6ebf4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 23 additions and 0 deletions

22
.readthedocs.yaml Normal file
View File

@ -0,0 +1,22 @@
# Read the Docs configuration file for Sphinx projects
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
version: 2
build:
os: ubuntu-22.04
tools:
python: "3.12"
sphinx:
configuration: docs/conf.py
# TODO: Enable this when we get rid of the existing warnings
# fail_on_warning: true
python:
install:
- method: pip
path: .
# TODO: pin the development dependency versions
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
# - requirements: docs/requirements.txt

View File

@ -11,3 +11,4 @@ recursive-include docs *.html
recursive-include docs *.py
recursive-include docs *.rst
recursive-include docs Makefile
exclude .readthedocs.yaml