tobiko/.readthedocs.yaml
Slawek Kaplonski 0ad9f57945 Include release notes in the main docs page of Tobiko
This patch adds link to the release notes in the main doc source
directory to include it in the build of the main documentation page.
With that release notes are included at the main page of the
Tobiko documentation.

Additionally this patch adds missing files for the already released
versions of the Tobiko which have release notes written.

From now on it is required to add new file in the releasenotes/source/
directory for every new version which will be released.

Related: #TOBIKO-13
Change-Id: I053b4bac735139b19ce06f166b4c99c218002821
2024-12-03 12:55:12 +01:00

31 lines
708 B
YAML

# .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"
jobs:
post_checkout:
- git fetch --unshallow || true
# 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