Skip to content

Commit

Permalink
docs: add readthedocs configuration file
Browse files Browse the repository at this point in the history
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
  • Loading branch information
sebix committed Sep 5, 2023
1 parent a86a587 commit 3e4be82
Show file tree
Hide file tree
Showing 3 changed files with 25 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

# Required
version: 2

# Set the OS, Python version 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: docs/conf.py

# Optional but recommended, declare the Python requirements required
# to build your documentation
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
# python:
# install:
# - requirements: docs/requirements.txt
2 changes: 2 additions & 0 deletions .readthedocs.yaml.license
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
SPDX-FileCopyrightText: 2023 Institute for Common Good Technology <[email protected]>
SPDX-License-Identifier: AGPL-3.0-or-later
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ CHANGELOG
#### Outputs

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

### Packaging

Expand Down

0 comments on commit 3e4be82

Please sign in to comment.