-
-
Notifications
You must be signed in to change notification settings - Fork 53
/
.readthedocs.yaml
45 lines (39 loc) · 1.71 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
35
36
37
38
39
40
41
42
43
44
45
# --------------------( LICENSE )--------------------
# Copyright (c) 2014-2024 Beartype authors.
# See "LICENSE" for further details.
#
# --------------------( SYNOPSIS )--------------------
# Project-wide Read The Docs (RTD) configuration.
# ....................{ METADATA }....................
# RTD configuration scheme version this file complies with.
version: 2
# ....................{ BUILD }....................
build:
# Build under the most recent Long Term Service (LTS) release of Ubuntu.
os: ubuntu-22.04
tools:
# Build under the most recently released minor version of CPython.
python: '3.12'
# ....................{ PYTHON }....................
python:
install:
# Install documentation dependencies by effectively running this command:
# $ pip install -e .[doc-rtd]
#
# That is, instruct RTD to install the "doc-rtd" extra defined by our
# top-level setuptools-based "setup.py" script, preserving DRY.
- method: pip
path: .
extra_requirements:
- doc-rtd
# ....................{ SPHINX }....................
sphinx:
# Relative filename of the Sphinx-specific configuration script configuring
# document generation for this project.
configuration: doc/src/conf.py
#FIXME: Unclear why we need this, but we probably do. *shrug*
builder: dirhtml
#FIXME: Uncomment the following *AFTER* eliminating all warnings across our
#documentation. Since we have yet to do so, this remains commented. It is sad.
# # For safety, convert non-fatal Sphinx warnings into fatal errors.
# fail_on_warning: true