Skip to content

Commit 0c66eb4

Browse files
committed
Add the required .readthedocs.yaml file
1 parent c678b05 commit 0c66eb4

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

.readthedocs.yaml

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# .readthedocs.yaml
2+
# Read the Docs configuration file
3+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
4+
5+
# Required
6+
version: 2
7+
8+
# Set the version of Python and other tools you might need
9+
build:
10+
os: "ubuntu-22.04"
11+
tools:
12+
python: "3.10"
13+
# You can also specify other tool versions:
14+
# nodejs: "20"
15+
# rust: "1.70"
16+
# golang: "1.20""
17+
18+
# Build documentation in the docs/ directory with Sphinx
19+
sphinx:
20+
configuration: documentation/conf.py
21+
# You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
22+
# builder: "dirhtml"
23+
# Fail on all warnings to avoid broken references
24+
# fail_on_warning: true
25+
26+
# Optionally build your docs in additional formats such as PDF and ePub
27+
# formats:
28+
# - pdf
29+
# - epub
30+
31+
# Optional but recommended, declare the Python requirements required
32+
# to build your documentation
33+
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
34+
python:
35+
install:
36+
- requirements: documentation/requirements.txt

0 commit comments

Comments
 (0)