From 95bba2dc0a4c74f53594f3583cc3c2fb3dc081c0 Mon Sep 17 00:00:00 2001
From: Bill Mills <bill.mills@linaro.org>
Date: Tue, 19 May 2026 13:53:43 -0400
Subject: [PATCH 1/2] ReadTheDocs: Use the new "git checkout command" project
 setting

Use the new "git checkout command" in the RTDs project settings to do all
the checkout operations. This greatly simplifies the sub-module PR
integration as the submodules will use the .readthedocs.yaml and conf.py
for the main openamp-docs repo and main branch.

* Eliminate the post_checkout job as it will interfere with the sub-module
  builds.
* Document the project settings for the main project
* Document the project setting for the sub-modules

Signed-off-by: Bill Mills <bill.mills@linaro.org>
---
 .readthedocs.yaml | 27 ++++++++++++++++++++++++---
 1 file changed, 24 insertions(+), 3 deletions(-)

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
index ec579ee..0ddbe9a 100644
--- a/.readthedocs.yaml
+++ b/.readthedocs.yaml
@@ -1,3 +1,27 @@
+# We now do all check-out related operations in the "git checkout command" of
+# the ReadtheDocs project settings.  There is no longer any post_checkout job
+# here.
+#
+# For the main project, the settings should look like:
+#   git clone $READTHEDOCS_GIT_CLONE_URL .
+#   git checkout --force $READTHEDOCS_GIT_IDENTIFIER
+#   git submodule sync
+#   git submodule update --init --force --recursive
+
+# To build PRs for submodules you will need to create a new RTDs project for
+# the submodule repo and enable the "build PRs" setting.
+# Assume:
+#  using the main repo for the openamp-docs project,
+#     you could also use your own fork of openamp-docs if you have one
+#  the submodule is open-amp, fix the "cd" for others
+# The "git checkout command" should look like:
+#   git clone --recurse-submodules https://github.com/OpenAMP/openamp-docs.git .
+#   (cd open-amp; git remote add this_pr $READTHEDOCS_GIT_CLONE_URL )
+#   (cd open-amp; if [ x"$READTHEDOCS_VERSION_TYPE" = x"branch" ]; then git fetch this_pr $READTHEDOCS_GIT_IDENTIFIER; else git fetch this_pr pull/$READTHEDOCS_GIT_IDENTIFIER/head; fi )
+#   (cd open-amp; git checkout --force FETCH_HEAD )
+#   (cd open-amp; git log -n 1 --oneline)
+#   git submodule status
+
 version: 2
 formats: all
 sphinx:
@@ -11,9 +35,6 @@ build:
     - libhugetlbfs-dev
     - libsysfs-dev
   jobs:
-    post_checkout:
-      - git submodule sync
-      - git submodule update --init --force --recursive
     post_install:
       - python -m pip install --exists-action=w --no-cache-dir -r requirements.txt
     pre_build:

From de30c29adacc3af8b7771d78cc11966a8d7e9f94 Mon Sep 17 00:00:00 2001
From: Bill Mills <bill.mills@linaro.org>
Date: Mon, 18 May 2026 14:04:59 -0400
Subject: [PATCH 2/2] Read The Docs: Update to Ubuntu 26.04 and Python 3.14

Update to Ubuntu 26.04 as 22.04 will be obsolete in a year.
Use Python 3.14 as this is the stock version for Ubuntu 26.04.

Signed-off-by: Bill Mills <bill.mills@linaro.org>
---
 .readthedocs.yaml | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
index 0ddbe9a..9852bf5 100644
--- a/.readthedocs.yaml
+++ b/.readthedocs.yaml
@@ -27,9 +27,9 @@ formats: all
 sphinx:
   configuration: ./conf.py
 build:
-  os: "ubuntu-22.04"
+  os: "ubuntu-26.04"
   tools:
-    python: "3.10"
+    python: "3.14"
   apt_packages:
     - cmake
     - libhugetlbfs-dev