blob: f89fc906ddea4c8eddb1f402f39ac1b57c46a247 [file] [log] [blame]
Arthur Shee61625a2024-01-06 20:46:36 -08001# .readthedocs.yaml
2# Read the Docs configuration file
3# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
Arthur She293df662024-01-06 20:41:15 -08004
Arthur Shee61625a2024-01-06 20:46:36 -08005# Required
Arthur She293df662024-01-06 20:41:15 -08006version: 2
7
Arthur Shee61625a2024-01-06 20:46:36 -08008# Set the OS, Python version and other tools you might need
Arthur She293df662024-01-06 20:41:15 -08009build:
Arthur Shee61625a2024-01-06 20:46:36 -080010 os: ubuntu-22.04
Arthur She293df662024-01-06 20:41:15 -080011 tools:
Arthur Shee61625a2024-01-06 20:46:36 -080012 python: "3.12"
13 # You can also specify other tool versions:
14 # nodejs: "19"
15 # rust: "1.64"
16 # golang: "1.19"
Arthur She293df662024-01-06 20:41:15 -080017
Arthur Shee61625a2024-01-06 20:46:36 -080018# Build documentation in the "docs/" directory with Sphinx
Arthur She293df662024-01-06 20:41:15 -080019sphinx:
20 configuration: docs/conf.py
21
Arthur Shee61625a2024-01-06 20:46:36 -080022# Optionally build your docs in additional formats such as PDF and ePub
23# formats:
24# - pdf
25# - epub
Arthur She293df662024-01-06 20:41:15 -080026
Arthur Shee61625a2024-01-06 20:46:36 -080027# Optional but recommended, declare the Python requirements required
28# to build your documentation
29# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
30# python:
31# install:
32# - requirements: docs/requirements.txt