Skip to content

Commit d2b494b

Browse files
authored
Fix readthedocs yaml (#58)
* Update docstrings * Add Sphinx documentation * Add github workflow to check docs build * Ignore docs build directory * Add Sphinx dependencies * Formatting * Add rtd file * Formatting * Try fix for failing docs workflow * Fix Sphinx file
1 parent baf060d commit d2b494b

1 file changed

Lines changed: 17 additions & 5 deletions

File tree

.readthedocs.yaml

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,22 @@
1+
# Read the Docs configuration file
2+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
3+
4+
# Required
15
version: 2
26

7+
# Set the OS, Python version, and other tools you might need
8+
build:
9+
os: ubuntu-24.04
10+
tools:
11+
python: "3.13"
12+
13+
# Build documentation in the "docs/" directory with Sphinx
314
sphinx:
4-
configuration: docs/conf.py
15+
configuration: docs/conf.py
516

17+
# Optionally, but recommended,
18+
# declare the Python requirements required to build your documentation
19+
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
620
python:
7-
install:
8-
- requirements: requirements.txt
9-
- method: pip
10-
path: .
21+
install:
22+
- requirements: requirements.txt

0 commit comments

Comments
 (0)