Skip to content

Feature/remove toc not included warnings #82

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
sipke wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Feature/remove toc not included warnings #82

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6409dae
index: add explicit hidden toc for any submodule files not to include
Dec 22, 2025
72f2465
demos: add references to openamp-system-reference build documentation
Dec 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions demos/echo.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,3 +117,17 @@ This Echo Test Sample is demonstrated in the following reference implementations
* :ref:`Docker Images<docker-images-label>` as demo1A
* :ref:`AMD-Xilinx platforms<demos-AMD-work-label>`
* :ref:`Inter Process Demos<inter-process-reference-label>`


.. toctree::
:maxdepth: 2
:caption: System Reference Build Information

../openamp-system-reference/examples/legacy_apps/README


.. toctree::
:maxdepth: 2
:caption: Echo Test Build Information

../openamp-system-reference/examples/legacy_apps/examples/echo/README
Copy link
Collaborator

@arnopo arnopo Jan 26, 2026

Choose a reason for hiding this comment

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

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.

Copy link
Author

@sipke sipke Feb 1, 2026

Choose a reason for hiding this comment

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

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.

11 changes: 11 additions & 0 deletions index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,14 @@ Welcome to the OpenAMP Project Documentation
protocol_details/index
docs/porting_guide
openamp/glossary


..
TOC entries used to suppress warnings we accept for files not included in a table of contents.
WARNING: document isn't included in any toctree [toc.not_included]

.. toctree::
:hidden:

openamp-system-reference/README
openamp-system-reference/LICENSE