From 0a57ca18e4a1719ee16164afb8c5336e5e6a6e91 Mon Sep 17 00:00:00 2001 From: Ian Stapleton Cordasco Date: Sat, 7 Jun 2025 12:49:34 -0500 Subject: [PATCH] Add readthedocs config --- docs/.readthedocs.yaml | 43 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 docs/.readthedocs.yaml diff --git a/docs/.readthedocs.yaml b/docs/.readthedocs.yaml new file mode 100644 index 0000000..ccad8ed --- /dev/null +++ b/docs/.readthedocs.yaml @@ -0,0 +1,43 @@ +# Read the Docs configuration file for Sphinx projects +# 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 +build: + os: ubuntu-lts-latest + + tools: + python: "latest" + + # You can also specify other tool versions: + # nodejs: "20" + # rust: "1.70" + # golang: "1.20" + + +# Build documentation in the "docs/" directory with Sphinx + +sphinx: + configuration: docs/source/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: docs/source/requirements.txt