forked from Urban-Meteorology-Reading/Tutorials
-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy path.readthedocs.yaml
37 lines (30 loc) · 1.03 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
# Read the Docs configuration file for Sphinx projects
# See httpsdocs.readthedocs.ioenstableconfig-filev2.html for details
# Required
version: 2
# Set the OS, Python version and other tools you might need
# Set the OS, Python version and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3.11"
python:
install:
- requirements: docs/source/requirements.txt
# Build documentation in the docs directory with Sphinx
sphinx:
configuration: docs/source/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 httpsdocs.readthedocs.ioenstableguidesreproducible-builds.html
# python
# install
# - requirements docsrequirements.txt