-
Notifications
You must be signed in to change notification settings - Fork 66
/
.readthedocs.yaml
34 lines (30 loc) · 1.05 KB
/
.readthedocs.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
# Required
version: 2
# Set the version of Python and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3.11"
jobs:
# We want to replace the build command itself but the "Override the build
# process" feature means we have to reimplement everything, so instead we
# "Extend the build process" and set up a dummy no-op conf.py in
# `pre_build` so `build` doesn't do anything, then actually build in
# `post_build`.
pre_build:
- mkdir dummy
- touch dummy/conf.py dummy/contents.rst
post_build:
- rm -rf dummy _readthedocs/html
- make html LANGUAGE=python3 BUILDDIR=_readthedocs
# (Don't) build documentation with Sphinx
sphinx:
configuration: dummy/conf.py
# We recommend specifying your dependencies to enable reproducible builds:
# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
python:
install:
- requirements: requirements.txt