Docs: enable readthedocs rendering (for PRs) #256
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The Readthedocs pull-request integration is nice to have for PR review. 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. Signed-off-by: Bill Mills <bill.mills@linaro.org>
|
This is now working on my libmetal fork. The read the docs project is already created and the webhook is already installed for this repo. After we are satisfied with libmetal, it is easy to setup for the other submodules of openamp-docs. |
Detect when we are a submodule of OpenAMP-docs. If so use the top level's Doxyfile overrides on top of our Doxyfile. If not, no change. Signed-off-by: Bill Mills <bill.mills@linaro.org>
|
@arnopo any objection to accepting this now so we can start using it and stop getting false CI failures? |
Indeed, it is better to integrate it quickly. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The Readthedocs pull-request integration is nice to have for PR review. 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.