Update .readthedocs.yaml

This commit is contained in:
Ishaan Jaff 2023-07-29 08:59:00 -07:00 committed by GitHub
parent a168cf8b9c
commit 25c4d0f940
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -1,32 +1,29 @@
# .readthedocs.yaml
# 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 # Required
version: 2 version: 2
# Set the OS, Python version 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
tools: tools:
python: "3.11" python: "3.11"
# You can also specify other tool versions: jobs:
# nodejs: "19" pre_build:
# rust: "1.64" - python docs/api_reference/create_api_rst.py
# golang: "1.19"
# Build documentation in the "docs/" directory with Sphinx # Build documentation in the docs/ directory with Sphinx
sphinx: sphinx:
configuration: docs/conf.py configuration: docs/api_reference/conf.py
# Optionally build your docs in additional formats such as PDF and ePub # If using Sphinx, optionally build your docs in additional formats such as PDF
# formats: # formats:
# - pdf # - pdf
# - epub
# Optional but recommended, declare the Python requirements required # Optionally declare the Python requirements required to build your docs
# to build your documentation python:
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html install:
# python: - requirements: docs/api_reference/requirements.txt
# install: - method: pip
# - requirements: docs/requirements.txt path: .