Open
Conversation
added 16 commits
February 23, 2026 14:51
sphinx, as used in readthedocs can embed an md page, so do that here for read the docs, but leave the relative link for anyone that comes across this page via github directly. Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
Intent is to embed this page into readthedocs, so reword the title and provide some repository links for context. Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
With the intent of providing individual execution shell blocks in each application/example sub directory remove the generic example from this build page. This is primarily as this page is intended to be embedded in the readthedocs so having htis shell block will not be intuitive there. Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
to address issue OpenAMP/openamp-docs#84 change all code blocks to markdown shell block. Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
With this build file being included in readthedocs, we want to ensure the first heading is the main title, so shift all others out. Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
sphinx, as used in readthedocs can embed an md page, so do that here for read the docs, but leave the relative link for anyone that comes across this page via github directly. Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
sphinx, as used in readthedocs can embed an md page, so do that here for read the docs, but leave the relative link for anyone that comes across this page via github directly. Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
… file sphinx, as used in readthedocs can embed an md page, so do that here for read the docs, but leave the relative link for anyone that comes across this page via github directly. Remove the title as the embed adds the title. Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
…ration This page will be embedded into readthedoc demo/examples so the two example references are not intuitive and they seem not to work on github markdown anyway, so not a big loss removing them from that repository. Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
sphinx, as used in readthedocs can embed an md page, so do that here for read the docs, but leave the relative link for anyone that comes across this page via github directly. Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
…demo To make for easier copying of commands remove the prompt from the start of command examples. Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
Make headings consecutive to fix the header warning WARNING: Non-consecutive header level increase Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
The bullet point was multiline sentence so needs an indentation to avoid the warning. WARNING: Bullet list ends without a blank line; unexpected unindent. Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
most of the code-block indentation was slightly out, so correct to avoid the error. ERROR: Error in "code-block" directive Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
The readme file was referenced by documentation through table of contents but as it had no title could not be created and skipped. Add a title to avoid the warning: toctree contains reference to document 'openamp-system-reference/examples/libmetal/machine/remote/amd_rpu/ system/generic/README' that doesn't have a title: no link will be generated [toc.no_title] Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
Sphinx config has title generating automatic references so create unique titles in this file to avoid the warning: WARNING: duplicate label ... Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
This pull request (PR) supports openamp-docs PR OpenAMP/openamp-docs#82, whose intent is to integrate git submodule documentation into openamp readthedocs.
Any markdown (.md) or restructured text (.rst) not included in openamp-docs show up as sphinx documentation warnings "toc not included", so these are either introduced into readthedocs or hidden if not relevant.