Conversation
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>
| :parser: myst_parser.sphinx_ | ||
|
|
||
| If you are perusing the github repository refer to the `legacy_apps README.md <../../README.md>`_ | ||
| for compilation information. |
There was a problem hiding this comment.
Could you please point me to where I can see the impact of this change in the generated documentation ( if any)?
There was a problem hiding this comment.
There are two places to look at.
The readmes in this repository (the submodule in openamp-docs), which will be on the branch on my fork, in the echo case
https://github.com/sipke/openamp-system-reference/tree/feature/remove-toc-not-included-warnings/examples/legacy_apps/examples/echo
and then the pull request sphinx build in openamp-docs the addtional section at end of echo demo
https://openamp--82.org.readthedocs.build/en/82/demos/echo.html#echo-test-build-information
repeat for each readme modified by this PR.
There was a problem hiding this comment.
I can see it on PR #82 generated doc but on on #99
https://openamp-system-reference-prs--99.org.readthedocs.build/en/99/demos/echo.html. I missed something?
There was a problem hiding this comment.
I presume the documentation build check of this repository does so against the openAMP/openamp-docs main branch, hence you would not see it in this PR 99, whereas you do in openamp-docs PR 82 as it is against the incoming branch feature/remove-toc-not-included-warnings of the openamp-docs.
The change you would see for this repository is in the example readme files found in the forked branch, as this one for echo:
3 participants
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.