Skip to content

Commit bb23ee1

Browse files
committed
readthedocs: add readthedocs.yml
readthedocs.org now requires this
1 parent 1f49a66 commit bb23ee1

File tree

1 file changed

+48
-0
lines changed

1 file changed

+48
-0
lines changed

.readthedocs.yml

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
2+
3+
# Read the Docs configuration file for Sphinx projects
4+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
5+
6+
# Required
7+
version: 2
8+
9+
# Set the OS, Python version and other tools you might need
10+
build:
11+
os: ubuntu-22.04
12+
tools:
13+
python: "3.12"
14+
# You can also specify other tool versions:
15+
# nodejs: "20"
16+
# rust: "1.70"
17+
# golang: "1.20"
18+
jobs:
19+
post_create_environment:
20+
# Install poetry
21+
# https://python-poetry.org/docs/#installing-manually
22+
- pip install poetry
23+
post_install:
24+
# Install dependencies with 'docs' dependency group
25+
# https://python-poetry.org/docs/managing-dependencies/#dependency-groups
26+
# VIRTUAL_ENV needs to be set manually for now.
27+
# See https://github.com/readthedocs/readthedocs.org/pull/11152/
28+
- cd doc && VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH poetry install
29+
30+
# Build documentation in the "docs/" directory with Sphinx
31+
sphinx:
32+
configuration: doc/conf.py
33+
# You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
34+
# builder: "dirhtml"
35+
# Fail on all warnings to avoid broken references
36+
# fail_on_warning: true
37+
38+
# Optionally build your docs in additional formats such as PDF and ePub
39+
# formats:
40+
# - pdf
41+
# - epub
42+
43+
# Optional but recommended, declare the Python requirements required
44+
# to build your documentation
45+
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
46+
# python:
47+
# install:
48+
# - requirements: docs/requirements.txt

0 commit comments

Comments
 (0)