-
-
Notifications
You must be signed in to change notification settings - Fork 130
/
.readthedocs.yaml
51 lines (46 loc) · 1.55 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
46
47
48
49
50
51
# Read the Docs configuration file for Sphinx projects
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
# Required
version: 2
# Set the OS, Python version and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3.11"
# jobs:
# pre_create_environment:
# # Select Python version (keep in sync with other versions):
# - asdf install python 3.11.5
# - asdf global python 3.11.5
# - python -m pip install --upgrade --no-cache-dir virtualenv
#
# # Install poetry:
# - asdf plugin add poetry
# - asdf install poetry 1.5.1
# - asdf global poetry 1.5.1
# - poetry config virtualenvs.create false
# post_install:
# # Install dependencies with 'docs' dependency group
# # https://python-poetry.org/docs/managing-dependencies/#dependency-groups
## - poetry install --with docs
# - make install
# Build documentation in the "docs/" directory with Sphinx
sphinx:
configuration: docs/conf.py
# You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
# builder: "dirhtml"
# Fail on all warnings to avoid broken references
# fail_on_warning: true
# Optionally build your docs in additional formats such as PDF and ePub
# formats:
# - pdf
# - epub
# Optional but recommended, declare the Python requirements required
# to build your documentation
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
python:
install:
- method: pip
path: .
extra_requirements:
- docs