Skip to content

Commit 8c0cbde

Browse files
committed
Add readthedocs v2 config file, update to py38, and fix requirements
1 parent f8f4355 commit 8c0cbde

File tree

2 files changed

+36
-0
lines changed

2 files changed

+36
-0
lines changed

.readthedocs.yaml

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

requirements-docs.txt

+1
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ freezegun==0.3.7
1111
identify==1.0.6
1212
imagesize==0.7.1
1313
isort==4.2.5
14+
jinja2==3.0.3
1415
lazy-object-proxy==1.4.3
1516
mccabe==0.6.1
1617
mock==2.0.0

0 commit comments

Comments
 (0)