-
Notifications
You must be signed in to change notification settings - Fork 0
/
.readthedocs.yaml
47 lines (37 loc) · 1.19 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
# .readthedocs.yml
# Read the Docs configuration file
# 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.12"
# ALL JOBS implied: https://docs.readthedocs.io/en/stable/builds.html
jobs:
pre_install:
- python --version
- python -m pip install poetry
- python -m poetry export -o req-docs.txt -E docs
post_install:
- python -m pip install -e .
- python -m pip install pyyaml
pre_build:
- python ./scripts/visualize-ga-workflow.py > ./docs/cicd_mermaid.md
- python ./scripts/visualize-dockerfile.py > ./docs/dockerfile_mermaid.md
# Build documentation in the docs/ directory with Sphinx
sphinx:
builder: html
configuration: docs/source/conf.py
fail_on_warning: false
# Optionally build your docs in additional formats such as PDF
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:
- requirements: docs/requirements.txt