Skip to content

Commit

Permalink
Fix h's readthedocs build
Browse files Browse the repository at this point in the history
h's readthedocs build has been failing for over eleven months, see:

https://readthedocs.org/projects/h/builds/

> Error
>
> The required .readthedocs.yaml configuration file was not found at
> repository's root. Learn how to use this file in our
> [configuration file tutorial](https://docs.readthedocs.io/en/stable/config-file/index.html).

The linked tutorial explains that we need to add a `.readthedocs.yaml`
configuration file, which must be in the root of the repo.
  • Loading branch information
seanh committed Sep 5, 2024
1 parent 69858e1 commit 7678f52
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
version: 2
build:
os: ubuntu-24.04
tools:
python: "3.12"
sphinx:
configuration: docs/conf.py
builder: "dirhtml"
fail_on_warning: true
formats: all
python:
install:
- requirements: requirements/docs.txt

0 comments on commit 7678f52

Please sign in to comment.