commit 7ce8fba3cbf2174917e1672ac557fbba3493a121
author Bence Szépkúti <bence.szepkuti@arm.com> Fri Apr 14 16:36:19 2023 +0200
committer Bence Szépkúti <bence.szepkuti@arm.com> Tue May 02 20:16:12 2023 +0200
tree d8f9dac0146758a120894e2a04028791c0cda07d
parent 4f4c87b01e99fb9fc62b5872cdb90d266bf01dbf

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>

.readthedocs.yaml

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
index cef07bf..104ef76 100644
--- a/.readthedocs.yaml
+++ b/.readthedocs.yaml
@@ -12,8 +12,11 @@
     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:

docs/redirects.yaml

diff --git a/docs/redirects.yaml b/docs/redirects.yaml
new file mode 100644
index 0000000..c3a13f3
--- /dev/null
+++ b/docs/redirects.yaml
@@ -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/