From b9fed4fcf2249c3d87c390c98c66d7859d39231f Mon Sep 17 00:00:00 2001 From: Paul Holzinger Date: Tue, 29 Oct 2024 17:18:22 +0100 Subject: [PATCH 1/2] readthedocs: build extra formats Make our docs available in extra formats to download, ref https://docs.readthedocs.io/en/stable/config-file/v2.html#formats Fixes: #24354 Signed-off-by: Paul Holzinger --- .readthedocs.yaml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 996c397f61..501aa38100 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -14,6 +14,12 @@ build: sphinx: configuration: docs/source/conf.py +# Optionally build your docs in additional formats +formats: + - htmlzip + - epub + - pdf + # We recommend specifying your dependencies to enable reproducible builds: # https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html python: From f4be5e34c2d52f210f2e74664dfc694d61414081 Mon Sep 17 00:00:00 2001 From: Paul Holzinger Date: Tue, 29 Oct 2024 17:20:21 +0100 Subject: [PATCH 2/2] docs: add missing swagger links for the stable branches It is part of the release process yet everybody ignores this. I really should look into automating this instead. Signed-off-by: Paul Holzinger --- docs/source/Reference.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/source/Reference.rst b/docs/source/Reference.rst index ae80d66de8..297ec6dfc4 100644 --- a/docs/source/Reference.rst +++ b/docs/source/Reference.rst @@ -7,6 +7,10 @@ Show the API documentation for version: * `latest (main branch) <_static/api.html>`_ +* `version 5.2 <_static/api.html?version=v5.2>`_ + +* `version 5.1 <_static/api.html?version=v5.1>`_ + * `version 5.0 <_static/api.html?version=v5.0>`_ * `version 4.9 <_static/api.html?version=v4.9>`_