Add post-build step to update redirects

This allows us to maintain the list of redirects in-tree.

Signed-off-by: Bence Szépkúti <bence.szepkuti@arm.com>
This commit is contained in:
Bence Szépkúti 2023-04-14 16:36:19 +02:00
parent 4f4c87b01e
commit 7ce8fba3cb
2 changed files with 15 additions and 2 deletions

View file

@ -12,8 +12,11 @@ build:
python: "3.9"
jobs:
pre_build:
- make apidoc
- breathe-apidoc -o docs/api apidoc/xml
- make apidoc
- breathe-apidoc -o docs/api apidoc/xml
post_build:
- '[ "$READTHEDOCS_VERSION" != "development" ] || "$READTHEDOCS_VIRTUALENV_PATH/bin/rtd" projects "Mbed TLS API" redirects sync --wet-run -f docs/redirects.yaml'
# Build documentation in the docs/ directory with Sphinx
sphinx:

10
docs/redirects.yaml Normal file
View file

@ -0,0 +1,10 @@
# Readthedocs redirects
# See https://docs.readthedocs.io/en/stable/user-defined-redirects.html
#
# In order to prevent exposing the API token, PR jobs do not update the
# redirects - changes to this file are only applied when they are merged
# into the main branch.
- type: exact
from_url: /projects/api/en/latest/$rest
to_url: /projects/api/en/development/