Add readthedocs.yaml configuration file

This file is used to configure RTD docs builds for the project.

Change-Id: I802dae3f9dae8178c4a152339125d9f71806d73f
This commit is contained in:
Slawek Kaplonski 2023-05-26 16:10:00 +02:00
parent f45e83a175
commit fb96fe49bb

28
.readthedocs.yaml Normal file
View File

@ -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