Skip to content

Commit 4e5b90b

Browse files
committed
Add Read the Docs config file
This is going to be required starting September 25, 2023.
1 parent 7d369a8 commit 4e5b90b

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

.readthedocs.yaml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
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 we 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+
# Build the docs in additional formats: PDF and ePub
19+
formats:
20+
- pdf
21+
- epub
22+
23+
# TODO: Specify dependencies to enable reproducible builds:
24+
# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
25+
# python:
26+
# install:
27+
# - requirements: docs/requirements.txt

0 commit comments

Comments
 (0)