Skip to content

Commit

Permalink
Provide ReadTheDocs configuration (#275) (#240)
Browse files Browse the repository at this point in the history
RTD has been requiring a configuration file for a while, this change
should resolve the currently ongoing documentation build failures.
  • Loading branch information
jstasiak authored Dec 13, 2023
1 parent 82929b6 commit c7d1f6e
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 0 deletions.
22 changes: 22 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -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
1 change: 1 addition & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@ recursive-include docs *.html
recursive-include docs *.py
recursive-include docs *.rst
recursive-include docs Makefile
exclude .readthedocs.yaml

0 comments on commit c7d1f6e

Please sign in to comment.