Skip to content

Commit 0067ee6

Browse files
authored
chore: add readthedocs config (#220)
https://blog.readthedocs.com/migrate-configuration-v2/ The new config allow us to specify the package requirements of the docs, this should fix the build process at readthedocs.
1 parent c3c3613 commit 0067ee6

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

.readthedocs.yaml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
# Read the Docs configuration file for Sphinx projects
3+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
4+
5+
# Required
6+
version: 2
7+
8+
# Set the OS, Python version and other tools you might need
9+
build:
10+
os: ubuntu-22.04
11+
tools:
12+
python: "3.11"
13+
14+
# Build documentation in the "docs/" directory with Sphinx
15+
sphinx:
16+
configuration: docs/conf.py
17+
18+
# Optionally build your docs in additional formats such as PDF and ePub
19+
formats: [pdf, epub]
20+
21+
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
22+
python:
23+
install:
24+
- method: pip
25+
path: .
26+
extra_requirements: [docs]

0 commit comments

Comments
 (0)