Conversation
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>
| :maxdepth: 2 | ||
| :caption: Echo Test Build Information | ||
|
|
||
| ../openamp-system-reference/examples/legacy_apps/examples/echo/README No newline at end of file |
There was a problem hiding this comment.
I wonder if we should not rework the readme files
../openamp-system-reference/examples/legacy_apps/README should perhaps describe how to set the compilation environment , and we should remove the Run application on a Linux PC chapter.
Link to openamp-system-reference/examples/legacy_apps/README in ../openamp-system-reference/examples/legacy_apps/examples/echo/README seems broken.
There was a problem hiding this comment.
Yes, adjusting readme files to suit inclusion into openamp docs would make sense.
Yes, as mentioned in the PR summary (second last paragraph) some links are broken as they do not use sphinx references. I did not fix those for this draft pull request as was just showing how the toc not included warnings can be corrected as example before proceeding to address all as there are quite some.
2 participants
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.