Feature/remove toc not included warnings #82
Draft
Conversation
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
added 2 commits
December 22, 2025 17:19
there are submodules which have document files just for the repository, so provide a toctree of hidden files so the warning about missing file in toc is suppressed. WARNING: document isn't included in any toctree [toc.not_included] Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
for ease of reference to build information in the submodule add a content table to the echo example documentation in the openamp-system-reference. This will also remove the warning that the file is not in a toc. WARNING: document isn't included in any toctree [toc.not_included] 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
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 PR is not complete and provided as an example follow on for PR #81.
All git submodules currently have files not included in openamp-docs, which results in warning
WARNING: document isn't included in any toctree [toc.not_included]
Most of the files could be integrated into the documentations, with first example given including the "build" information for the Echo Example of the openamp-system-reference.
There are some files harder to integrate and for those recommendation is to filter them out using the toc :hidden: feature which suppresses the warning.
Note, that some changes will be needed for files in submodules also as some of the links there are relative hyperlinks, rather than sphinx references. You will notice under Echo Test Build Information -> Compilation, the link to README.md does not work currently, as it is a relative hyperlink rather than sphinx reference. Solvable, just not done yet in this proposal.
If the proposal is acceptable, can proceed to eliminate toc.not_included warnings in one of the above two methods.