Skip to content

Commit 5688eac

Browse files
committed
add Read the Docs configuration file for documentation builds
1 parent 7ab8c4d commit 5688eac

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

.readthedocs.yaml

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
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.11"
13+
14+
# Build documentation in the docs/ directory with Sphinx
15+
sphinx:
16+
builder: html
17+
configuration: docs/source/conf.py
18+
19+
formats:
20+
- epub
21+
- pdf
22+
23+
# We recommend specifying your 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
28+
- method: pip
29+
path: docs/
30+
# extra_requirements:
31+
# - docs
32+
33+
# python:
34+
# version: 3.8
35+
# install:
36+
# - method: pip
37+
# path: .
38+
# - requirements: docs/requirements.txt
39+
# system_packages: False

0 commit comments

Comments
 (0)