Skip to content

Feature/remove toc not included warnings#1

Open
sipke wants to merge 2 commits intodanmilea:mainfrom
sipke:feature/remove-toc-not-included-warnings
Open

Feature/remove toc not included warnings#1
sipke wants to merge 2 commits intodanmilea:mainfrom
sipke:feature/remove-toc-not-included-warnings

Conversation

@sipke
Copy link
Copy Markdown

@sipke sipke commented Mar 16, 2026

This pull request (PR) supports openamp-docs PR OpenAMP/openamp-docs#82, whose intent is to integrate git submodule documentation into openamp readthedocs.
In doing so layout changes were needed and additional sphinx warnings were found which are addressed.

Sipke Vriend added 2 commits March 9, 2026 08:55
The Prerequisites and Building sub headings were at level H1, so bump
to H2.
On a readme page it is not noticeable but when integrating this readme to
openamp-docs repository, the sub headings were incorrectly rendered as
main headings in the table of contents.

Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
A reference to boards was missing, so add a new section with zcu102 at
least so remove the sphinx build warning.
 WARNING: undefined label: 'boards' [ref.ref]

Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
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.

1 participant