From 727fbbfe27b6dbeb76255c8866f69623571c4d50 Mon Sep 17 00:00:00 2001 From: "Maarten A. Breddels" Date: Wed, 3 Jul 2024 09:22:16 +0200 Subject: [PATCH] fix: add mandatory .readthedocs.yaml file --- .readthedocs.yaml | 44 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) create mode 100644 .readthedocs.yaml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000000..4429163875 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,44 @@ +# 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-22.04 + tools: + python: "3.10" + # You can also specify other tool versions: + # nodejs: "20" + # rust: "1.70" + # golang: "1.20" + commands: + - pip install --upgrade pip + - pip install -r requirements_rtd.txt + - pip install -e . + +# 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: + - path: . + - requirements: requirements_rtd.txt + + +submodules: + recursive: true