-
Notifications
You must be signed in to change notification settings - Fork 4
/
.readthedocs.yaml
35 lines (30 loc) · 1 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
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
# Required: The version key tells the system how to read the rest of the configuration file. The current and only supported version is version 2.
version: 2
# Set the OS, Python version and other tools you might need
build:
os: ubuntu-22.04 # Possible values ubuntu-20.04, ubuntu-22.04
tools:
python: "3.11"
#jobs:
# pre_create_environment:
# - echo "Command run at 'pre_create_environment' step"
# post_build:
# - echo "Command run at 'post_build' step"
# - echo `date`
# Build documentation in the "docs/" directory with Sphinx
mkdocs:
configuration: mkdocs.yml
# 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 ¨
python:
install:
- requirements: docs/requirements.txt
# - method: pip