From 40f08f2c8a52e1181ca7b8ae473754abcfd54bf1 Mon Sep 17 00:00:00 2001 From: "Jason M. Gates" Date: Mon, 10 Jun 2024 12:45:12 -0600 Subject: [PATCH] ci: Add ReadTheDocs configuration --- .readthedocs.yaml | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 .readthedocs.yaml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..6045ae5 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,25 @@ +# 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 need. +build: + os: "ubuntu-22.04" + tools: + python: "3.12" + +# Build documentation in the "doc/" directory with Sphinx. +sphinx: + fail_on_warning: true + configuration: doc/source/conf.py + +# Declare Python requirements for building the documentation. +python: + install: + - method: pip + path: . + - requirements: requirements.txt + - requirements: doc/requirements.txt