Skip to content

Commit c03ae57

Browse files
committed
docs: add .readthedocs.yaml
This should hopefully fix docs build bustage.
1 parent 3aa6222 commit c03ae57

File tree

2 files changed

+23
-1
lines changed

2 files changed

+23
-1
lines changed

.readthedocs.yaml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
version: 2
2+
formats:
3+
- htmlzip
4+
- pdf
5+
- epub
6+
build:
7+
os: ubuntu-24.04
8+
tools:
9+
python: "3.13"
10+
jobs:
11+
create_environment:
12+
- python3 -m venv venv
13+
- venv/bin/python3 -m pip install -c ci/constraints.txt -r ci/requirements.txt
14+
- venv/bin/python3 -m pip install Sphinx==5.3.0
15+
- venv/bin/python3 -m pip install --config-settings=--build-option=--no-c-backend .
16+
build:
17+
htmlzip:
18+
- make -C docs htmlzip SPHINXBUILD=$(pwd)/venv/bin/sphinx-build BUILDDIR=$READTHEDOCS_OUTPUT
19+
pdf:
20+
- make -C docs pdf SPHINXBUILD=$(pwd)/venv/bin/sphinx-build BUILDDIR=$READTHEDOCS_OUTPUT
21+
epub:
22+
- make -C docs epub SPHINXBUILD=$(pwd)/venv/bin/sphinx-build BUILDDIR=$READTHEDOCS_OUTPUT

docs/Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
SPHINXOPTS ?=
77
SPHINXBUILD ?= sphinx-build
88
SOURCEDIR = .
9-
BUILDDIR = _build
9+
BUILDDIR ?= _build
1010

1111
# Put it first so that "make" without argument is like "make help".
1212
help:

0 commit comments

Comments
 (0)