2023-08-28 14:17:52 +00:00
|
|
|
# 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.11"
|
|
|
|
# You can also specify other tool versions:
|
|
|
|
# nodejs: "19"
|
|
|
|
# rust: "1.64"
|
|
|
|
# golang: "1.19"
|
|
|
|
|
|
|
|
# Build documentation in the "docs/" directory with Sphinx
|
|
|
|
sphinx:
|
2023-08-28 15:23:48 +00:00
|
|
|
configuration: docs/conf.py
|
2023-08-28 14:17:52 +00:00
|
|
|
|
|
|
|
# Optionally build your docs in additional formats such as PDF and ePub
|
2023-08-28 14:45:47 +00:00
|
|
|
formats:
|
|
|
|
- pdf
|
|
|
|
- epub
|
2023-08-28 14:17:52 +00:00
|
|
|
|
|
|
|
# Optional but recommended, declare the Python requirements required
|
|
|
|
# to build your documentation
|
|
|
|
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
|
2023-08-28 14:45:47 +00:00
|
|
|
python:
|
|
|
|
install:
|
2023-08-28 15:23:48 +00:00
|
|
|
- requirements: docs/requirements.txt
|