Skip to content

Updates to the ReadtheDocs integration#89

Open
wmamills wants to merge 2 commits into
OpenAMP:mainfrom
wmamills:wam-rtds-fix-2026
Open

Updates to the ReadtheDocs integration#89
wmamills wants to merge 2 commits into
OpenAMP:mainfrom
wmamills:wam-rtds-fix-2026

Conversation

@wmamills
Copy link
Copy Markdown
Collaborator

@wmamills wmamills commented May 20, 2026

This PR contains two commits:

  • New process for RTDs projects using the new "git checkout command". This commit and the described RTDs project setting updates fix the sub-module PR build process and well as make it simpler.
  • Update to Ubuntu 26.04 and Python 3.14 (to keep things current)

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.

wmamills added 2 commits May 20, 2026 10:36
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>
@wmamills
Copy link
Copy Markdown
Collaborator Author

image image

@wmamills wmamills requested a review from arnopo May 20, 2026 15:07
@tnmysh tnmysh self-requested a review May 20, 2026 15:17
Copy link
Copy Markdown
Collaborator

@arnopo arnopo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@arnopo
Copy link
Copy Markdown
Collaborator

arnopo commented May 20, 2026

@sipke: could you have a look and give your feedback please?
Please also have alook to OpenAMP/open-amp#686

@wmamills wmamills changed the title Updates to the ReadtheDocs integrationx Updates to the ReadtheDocs integration May 21, 2026
@wmamills
Copy link
Copy Markdown
Collaborator Author

To document what we said on the meeting May 20, this can be merged before or after the tag of v2026.04.0
Once the RTDs project is updated with the new instructions it will still work with older versions of openamp-docs. The older version will re-checkout the sub-modules in the post_checkout step but they will use the same versions so it will be no-op.

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.

@sipke
Copy link
Copy Markdown

sipke commented May 22, 2026

The ubuntu change looks fine.
Removing readthedocs config from submodule is fantastic.
The main change of new "git checkout command" is mentioned in PR and the comment add detail, but where is this git checkout command actually happening? or is that what the last NOTE: of the PR is saying that there is more changes incoming?

@wmamills
Copy link
Copy Markdown
Collaborator Author

wmamills commented May 22, 2026

Hi @sipke, the change goes into the project settings for each repo in the ReadTheDocs control panel.
I will attach screen shots of what this looks like for my profile and my fork of open-amp lib

my profile:
image

My open-amp fork project, the settings is on the far right:
image

The settings main panel look like this:
image

@sipke
Copy link
Copy Markdown

sipke commented May 23, 2026

Understood and now that I do, looks perfect, much cleaner all and all than before.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants