Skip to content

Commit

Permalink
doc: add .readthedocs.yaml configs
Browse files Browse the repository at this point in the history
As of Sep 25 2023, RTD projects require config files to build. This
patch is necessary for docs to continue to build.

Signed-off-by: Quentin Young <qlyoung@qlyoung.net>
  • Loading branch information
qlyoung committed Sep 28, 2023
1 parent 52cc7f1 commit 4c38e55
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 0 deletions.
20 changes: 20 additions & 0 deletions doc/developer/.readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Required
version: 2

# Set the version of Python and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3.11"

# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: doc/developer/conf.py

python:
install:
- requirements: doc/requirements.txt

build:
tools:
python: 3.11
20 changes: 20 additions & 0 deletions doc/user/.readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Required
version: 2

# Set the version of Python and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3.11"

# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: doc/user/conf.py

python:
install:
- requirements: doc/requirements.txt

build:
tools:
python: 3.11

0 comments on commit 4c38e55

Please sign in to comment.