2023-05-05 23:45:26 +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 version of Python and other tools you might need
|
|
|
|
build:
|
|
|
|
os: ubuntu-22.04
|
|
|
|
tools:
|
|
|
|
python: "3.11"
|
2023-06-30 16:23:32 +00:00
|
|
|
jobs:
|
|
|
|
pre_build:
|
|
|
|
- python docs/api_reference/create_api_rst.py
|
2023-05-05 23:45:26 +00:00
|
|
|
|
|
|
|
# Build documentation in the docs/ directory with Sphinx
|
|
|
|
sphinx:
|
2023-06-16 18:52:56 +00:00
|
|
|
configuration: docs/api_reference/conf.py
|
2023-05-05 23:45:26 +00:00
|
|
|
|
|
|
|
# If using Sphinx, optionally build your docs in additional formats such as PDF
|
|
|
|
# formats:
|
|
|
|
# - pdf
|
|
|
|
|
|
|
|
# Optionally declare the Python requirements required to build your docs
|
|
|
|
python:
|
|
|
|
install:
|
2023-07-21 20:52:03 +00:00
|
|
|
- requirements: docs/api_reference/requirements.txt
|