Skip to content

Commit 92cb4b5

Browse files
committed
Added .readthedocs.yaml
Based it on the Sphinx example config file at https://docs.readthedocs.io/en/stable/config-file/v2.html. This should fix the recent build fail (see https://readthedocs.org/projects/django-simple-history/builds/21202330/), which was due to using a module that was added in Python 3 (`importlib.metadata`) with Python 2.7 - which is the version that's for some reason being used to build the docs.
1 parent 8c67876 commit 92cb4b5

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

.readthedocs.yaml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
# Read the Docs configuration file for Sphinx projects
3+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
4+
5+
# Required
6+
version: 2
7+
8+
# Set the OS, Python version 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+
configuration: docs/conf.py
17+
18+
# Optional but recommended, declare the Python requirements required
19+
# to build your documentation
20+
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
21+
python:
22+
install:
23+
- requirements: requirements/docs.txt

0 commit comments

Comments
 (0)