Skip to content

Commit 2d73e2e

Browse files
committed
Migrate RtD settings to config file
Read the Docs now requires all projects to use a settings file. https://blog.readthedocs.com/migrate-configuration-v2/ Also add a requirements file for the docs packages.
1 parent 850c98f commit 2d73e2e

File tree

2 files changed

+43
-0
lines changed

2 files changed

+43
-0
lines changed

.readthedocs.yml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# .readthedocs.yml
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+
build:
9+
os: "ubuntu-22.04"
10+
tools:
11+
python: "3.9"
12+
13+
# Build documentation in the docs/ directory with Sphinx
14+
sphinx:
15+
configuration: docs/conf.py
16+
17+
# Optionally set the version of Python and requirements required to build your docs
18+
python:
19+
install:
20+
- requirements: docs/requirements.txt

docs/requirements.txt

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
alabaster==0.7.13
2+
Babel==2.13.0
3+
certifi>=2023.7.22
4+
charset-normalizer==3.3.0
5+
docutils==0.16
6+
idna==3.4
7+
imagesize==1.4.1
8+
Jinja2==3.0.3
9+
MarkupSafe==2.1.3
10+
packaging==23.2
11+
Pygments==2.16.1
12+
requests>=2.31.0
13+
snowballstemmer==2.2.0
14+
Sphinx==3.5.4
15+
sphinx-rtd-theme==1.3.0
16+
sphinxcontrib-applehelp==1.0.4
17+
sphinxcontrib-devhelp==1.0.2
18+
sphinxcontrib-htmlhelp==2.0.1
19+
sphinxcontrib-jquery==4.1
20+
sphinxcontrib-jsmath==1.0.1
21+
sphinxcontrib-qthelp==1.0.3
22+
sphinxcontrib-serializinghtml==1.1.5
23+
urllib3==2.0.6

0 commit comments

Comments
 (0)