docs(readthedocs): streamline config (#30307)

This commit is contained in:
Oskar Stark 2025-03-18 10:47:45 -05:00 committed by GitHub
parent 5a6e1254a7
commit 492b4c1604
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -1,12 +1,7 @@
# Read the Docs configuration file # Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
# Required
version: 2 version: 2
formats:
- pdf
# Set the version of Python and other tools you might need # Set the version of Python and other tools you might need
build: build:
os: ubuntu-22.04 os: ubuntu-22.04
@ -15,15 +10,16 @@ build:
commands: commands:
- mkdir -p $READTHEDOCS_OUTPUT - mkdir -p $READTHEDOCS_OUTPUT
- cp -r api_reference_build/* $READTHEDOCS_OUTPUT - cp -r api_reference_build/* $READTHEDOCS_OUTPUT
# Build documentation in the docs/ directory with Sphinx # Build documentation in the docs/ directory with Sphinx
sphinx: sphinx:
configuration: docs/api_reference/conf.py configuration: docs/api_reference/conf.py
# If using Sphinx, optionally build your docs in additional formats such as PDF # If using Sphinx, optionally build your docs in additional formats such as PDF
# formats: formats:
# - pdf - pdf
# Optionally declare the Python requirements required to build your docs # Optionally declare the Python requirements required to build your docs
python: python:
install: install:
- requirements: docs/api_reference/requirements.txt - requirements: docs/api_reference/requirements.txt