From 7763d8397196b9b16427fb34ba3293ba63c84caf Mon Sep 17 00:00:00 2001 From: Pablo Santiago Blum de Aguiar Date: Sun, 23 Jul 2023 22:53:04 +0200 Subject: [PATCH] docs: Add a v2 .readthedocs.yaml config file Read the Docs will start requiring a .readthedocs.yaml configuration file for all projects in order to build documentation successfully. For more information, read the blog post available at: https://blog.readthedocs.com/migrate-configuration-v2/ --- .readthedocs.yaml | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 .readthedocs.yaml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 000000000..acf55c803 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,26 @@ +# .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.11" + +# Build documentation in the docs/ directory with Sphinx +sphinx: + configuration: docs/conf.py + +# Build docs in PDF and ePub formats +formats: + - pdf + - epub + +# Specify Python requirements +python: + install: + - requirements: docs/requirements.txt