Updates to the ReadtheDocs integration#89
Conversation
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>
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>
|
@sipke: could you have a look and give your feedback please? |
|
To document what we said on the meeting May 20, this can be merged before or after the tag of v2026.04.0 Doc builds for PRs of maintenance branches for sub-modules (like doing libmetal 2025.10.2) wont work correctly but won't fail either. Maintenance for a libmetal 2026.10.2 (after the elimination of the post_checkout job) would build the correct version of libmetal but su-modules PRs will also use the main branch of openamp-docs. Again this only effects doc builds for sub-module builds. All builds from openamp-docs will build the right thing. |
|
The ubuntu change looks fine. |
|
Hi @sipke, the change goes into the project settings for each repo in the ReadTheDocs control panel. |
|
Understood and now that I do, looks perfect, much cleaner all and all than before. |





This PR contains two commits:
As of April or May 2026, ReadtheDocs has changed something in their infrastructure that broken the way were doing sub-module PRs. Luckily, they have added a way to customize the git checkout command used by each RTDs project. This first commit changes things so we rely on that new setting.
The sub-module checkout procedure is still overly complex as RTDs currently lacks an ENV var that easily describes how to checkout the commit needed for each build. However the project settings needed are documented in comments in the .readthedocs.yaml file.
This has been tested (with Bill's repo forks) with latest open-amp lib and openamp-docs as of 2026-05-20 2PM UTC. The open-amp sub-module was tested for pushes to main and for a PR.
NOTE: The RTDs build checks for this PR will fail until I update the RTDs project for the main openamp-docs. I will do this after I get consenses on the patch.