From 5f481d13d5db3d8b86f697f2f5dec7bb87bd3bfb Mon Sep 17 00:00:00 2001 From: Jen Patague Date: Tue, 12 Dec 2023 13:00:17 -0800 Subject: [PATCH] TRON-2035: Fix public docs w/ new RTDv2 config --- .readthedocs.yaml | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 .readthedocs.yaml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 000000000..3339f3ec7 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,39 @@ +# Read the Docs configuration file for Sphinx projects +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# RTD defaults as of 2023-11-08 +build: + # TODO: Bump to jammy+3.8 once master branch updated + os: ubuntu-20.04 + tools: + python: "3.6" + # You can also specify other tool versions: + # nodejs: "20" + # rust: "1.70" + # golang: "1.20" + +# Also provide downloadable zip +formats: [htmlzip] + +# Build documentation in the "docs/" directory with Sphinx +sphinx: + configuration: docs/conf.py + # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs + # builder: "dirhtml" + # Fail on all warnings to avoid broken references + # fail_on_warning: true + +# Optionally build your docs in additional formats such as PDF and ePub +# 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: requirements-docs.txt