OpenAMP / openamp-system-reference

End-to-end system reference material showcasing all the different aspects of OpenAMP, on multiple vendor platforms.
Other
16 stars 15 forks source link

Docs: enable readthedocs rendering (for PRs) #24

Closed wmamills closed 1 year ago

wmamills commented 1 year ago

The Readthedocs pull-request integration is nice to have for PR review. So run the whole OpenAMP-docs build but use the PR's commit

This also requires a ReadTheDocs project to install its integration for this repo. The project should enable "Build pull request for this project". It is currently in the Advanced Settings panel.

The project will also run for the main branch but that should be ignored and only the main project URL should be shown outside of PRs.

To this end the sub-module project names will use "-prs" in the name.