blob: f11730ea9385c8fe9923e724a9c89c305f157e20 [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 She805c5122024-01-06 20:55:19 -080017# apt_packages:
18# -
19 jobs:
20 post_create_environment:
21 - pip install sphinx_rtd_theme
Arthur She293df662024-01-06 20:41:15 -080022
Arthur Shee61625a2024-01-06 20:46:36 -080023# Build documentation in the "docs/" directory with Sphinx
Arthur She293df662024-01-06 20:41:15 -080024sphinx:
25 configuration: docs/conf.py
26
Arthur Shee61625a2024-01-06 20:46:36 -080027# Optionally build your docs in additional formats such as PDF and ePub
28# formats:
29# - pdf
30# - epub
Arthur She293df662024-01-06 20:41:15 -080031
Arthur Shee61625a2024-01-06 20:46:36 -080032# Optional but recommended, declare the Python requirements required
33# to build your documentation
34# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
35# python:
36# install:
37# - requirements: docs/requirements.txt