Skip to content

Commit d9725a0

Browse files
committed
updated readthedocs config
1 parent 21815a1 commit d9725a0

File tree

3 files changed

+15
-16
lines changed

3 files changed

+15
-16
lines changed

.readthedocs.yml

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,21 @@
1-
# .readthedocs.yaml
21
# Read the Docs configuration file
32
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
43

5-
# Required
64
version: 2
75

8-
# Build documentation in the docs/ directory with Sphinx
6+
build:
7+
os: ubuntu-24.04
8+
tools:
9+
python: "3.12"
10+
911
sphinx:
10-
configuration: docs/conf.py
12+
configuration: docs/conf.py
1113

12-
# Optionally build your docs in additional formats such as PDF
1314
formats:
14-
- pdf
15+
- pdf
1516

16-
# Optionally set the version of Python and requirements required to build your docs
1717
python:
18-
version: 3
19-
install:
20-
- method: pip
21-
path: .
22-
- requirements: docs/requirements.txt
18+
install:
19+
- method: pip
20+
path: .
21+
- requirements: docs/requirements.txt

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838
autodoc_typehints = "none"
3939

4040
# Add any paths that contain templates here, relative to this directory.
41-
templates_path = ["_templates"]
41+
# templates_path = ["_templates"]
4242

4343
# List of patterns, relative to source directory, that match files and
4444
# directories to ignore when looking for source files.

docs/requirements.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
sphinx==4.3.0
2-
sphinx_rtd_theme==1.0.0
3-
myst-parser==0.15.2
1+
sphinx> 9.1.0
2+
sphinx-rtd-theme>=3.0.2
3+
myst-parser>=4.0.1

0 commit comments

Comments
 (0)