Skip to content

Commit 5079663

Browse files
committed
doc: add read the docs configuration file
As announced on https://blog.readthedocs.com/migrate-configuration-v2/, having a .readthedocs.yaml file at the root of the project becomes mandatory.
1 parent ab1a4b5 commit 5079663

File tree

2 files changed

+25
-0
lines changed

2 files changed

+25
-0
lines changed

.gitattributes

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ version.inc.in export-subst
66
.gitattributes export-ignore
77
init/.gitignore export-ignore
88
.cirrus.yml export-ignore
9+
.readthedocs.yaml export-ignore
910
codecov.yml export-ignore
1011
script/mb export-ignore
1112
script/mlprof export-ignore

.readthedocs.yaml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
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+
# You can also specify other tool versions:
14+
# nodejs: "19"
15+
# rust: "1.64"
16+
# golang: "1.19"
17+
18+
# Build documentation in the docs/ directory with Sphinx
19+
sphinx:
20+
configuration: doc/source/conf.py
21+
22+
# If using Sphinx, optionally build your docs in additional formats such as PDF
23+
# formats:
24+
# - pdf

0 commit comments

Comments
 (0)