From 031a29332a195a1845f5e2678e2a63f3de95e277 Mon Sep 17 00:00:00 2001 From: Patrick Ziegler Date: Mon, 8 May 2023 19:13:02 +0200 Subject: [PATCH] doc: Use readthedocs config file (#2957) This is the recommended way to configure the project instead of using the website. It should also help fix readthedocs/readthedocs.org#10290 --- .readthedocs.yaml | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 .readthedocs.yaml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 00000000..ff27254a --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,22 @@ +--- +# .readthedocs.yaml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Set the version of Python and other tools you might need +build: + os: ubuntu-22.04 + tools: + python: "3" + +# Build documentation in the docs/ directory with Sphinx +sphinx: + configuration: doc/conf.py + fail_on_warning: true + +# If using Sphinx, optionally build your docs in additional formats such as PDF +# formats: +# - pdf