From 25c4d0f940f302d4af2a134f74965d2686a3c23e Mon Sep 17 00:00:00 2001 From: Ishaan Jaff Date: Sat, 29 Jul 2023 08:59:00 -0700 Subject: [PATCH] Update .readthedocs.yaml --- .readthedocs.yaml | 29 +++++++++++++---------------- 1 file changed, 13 insertions(+), 16 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index aa209bb218..8e0c98ef81 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -1,32 +1,29 @@ -# .readthedocs.yaml # Read the Docs configuration file # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details # Required 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: os: ubuntu-22.04 tools: python: "3.11" - # You can also specify other tool versions: - # nodejs: "19" - # rust: "1.64" - # golang: "1.19" + jobs: + pre_build: + - python docs/api_reference/create_api_rst.py -# Build documentation in the "docs/" directory with Sphinx +# Build documentation in the docs/ directory with 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: # - pdf -# - epub -# Optional but recommended, declare the Python requirements required -# to build your documentation -# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html -# python: -# install: -# - requirements: docs/requirements.txt +# Optionally declare the Python requirements required to build your docs +python: + install: + - requirements: docs/api_reference/requirements.txt + - method: pip + path: .