Skip to content

Remove toc not included and other sphinx warnings#678

Merged
arnopo merged 3 commits intoOpenAMP:mainfrom
sipke:feature/remove-toc-not-included-warnings
Mar 31, 2026
Merged

Remove toc not included and other sphinx warnings#678
arnopo merged 3 commits intoOpenAMP:mainfrom
sipke:feature/remove-toc-not-included-warnings

Conversation

@sipke
Copy link
Copy Markdown

@sipke sipke commented Mar 23, 2026

This pull request (PR) supports openamp-docs PR OpenAMP/openamp-docs#82, whose intent is to better 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.
Also additional warnings added due to restructuring of some documents are removed.

Sipke Vriend added 3 commits March 16, 2026 14:08
to provide access to maintainers information for this repository add it
to the input source files.

Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
PERL_PATH and MSCGEN_PATH are no longer used, so remove from Doxyfile.in
to avoid warning:
to avoid warning
warning Tag 'PERL_PATH' ... has become obsolete.
warning: Tag 'MSCGEN_PATH' ... has become obsolete.

Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
file used by doxygen is doc/Doxyfile.in so remove the Doxyfile file
from root folder to avoid confusion.

Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
Copy link
Copy Markdown
Contributor

@edmooring edmooring left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to go.

@arnopo arnopo added this to the Release V2026.04 milestone Mar 31, 2026
@arnopo arnopo merged commit 4a6835e into OpenAMP:main Mar 31, 2026
5 checks passed
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.

3 participants