From a79ff0f83c7c9829ad98cbc144e094a3356c6b3f Mon Sep 17 00:00:00 2001 From: Kyle King Date: Tue, 24 Sep 2024 19:47:35 -0400 Subject: [PATCH] ci: update RTD configuration --- .readthedocs.yaml | 26 +++++++++++++++++++++----- 1 file changed, 21 insertions(+), 5 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 9b067d3..746d3fd 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -5,12 +5,28 @@ # Required version: 2 +# Set the OS, Python version and other tools you might need +build: + os: ubuntu-lts-latest + tools: + python: "3.12" + # Build documentation in the docs/ directory with Sphinx sphinx: - fail_on_warning: true + 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 -# Optionally set the version of Python and requirements required to build your docs +# Optional but recommended, declare the Python requirements required +# to build your documentation +# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html python: - version: '3.8' - install: - - requirements: docs/requirements.txt + install: + - requirements: docs/requirements.txt