From fb96fe49bbb0b0340f82cb0302f3d8e765d3937c Mon Sep 17 00:00:00 2001 From: Slawek Kaplonski Date: Fri, 26 May 2023 16:10:00 +0200 Subject: [PATCH] Add readthedocs.yaml configuration file This file is used to configure RTD docs builds for the project. Change-Id: I802dae3f9dae8178c4a152339125d9f71806d73f --- .readthedocs.yaml | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 .readthedocs.yaml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 000000000..15404a573 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,28 @@ +# .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.10" + +# Build documentation in the docs/ directory with Sphinx +sphinx: + builder: html + configuration: doc/source/conf.py + +# If using Sphinx, optionally build your docs in additional formats such as PDF +formats: + - pdf + - epub + +# Optionally declare the Python requirements required to build your docs +python: + install: + - requirements: doc/readthedocs_requirements.txt + system_packages: true