Skip to content

Commit 3e4be82

Browse files
committed
docs: add readthedocs configuration file
readthedocs now requires the configuration key "build.os" to build the documentation. used the template https://docs.readthedocs.io/en/stable/config-file/v2.html
1 parent a86a587 commit 3e4be82

File tree

3 files changed

+25
-0
lines changed

3 files changed

+25
-0
lines changed

.readthedocs.yaml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Read the Docs configuration file for Sphinx projects
2+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
3+
4+
# Required
5+
version: 2
6+
7+
# Set the OS, Python version and other tools you might need
8+
build:
9+
os: ubuntu-22.04
10+
tools:
11+
python: "3.11"
12+
13+
# Build documentation in the "docs/" directory with Sphinx
14+
sphinx:
15+
configuration: docs/conf.py
16+
17+
# Optional but recommended, declare the Python requirements required
18+
# to build your documentation
19+
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
20+
# python:
21+
# install:
22+
# - requirements: docs/requirements.txt

.readthedocs.yaml.license

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
SPDX-FileCopyrightText: 2023 Institute for Common Good Technology <[email protected]>
2+
SPDX-License-Identifier: AGPL-3.0-or-later

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ CHANGELOG
2828
#### Outputs
2929

3030
### Documentation
31+
- Add a readthedocs configuration file to fix the build fail (PR#2403 by Sebastian Wagner).
3132

3233
### Packaging
3334

0 commit comments

Comments
 (0)