From 6409dae57d5e158c23d3b589d731270f34887f93 Mon Sep 17 00:00:00 2001 From: Sipke Vriend Date: Mon, 22 Dec 2025 17:19:45 +1000 Subject: [PATCH 1/2] index: add explicit hidden toc for any submodule files not to include 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 --- index.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/index.rst b/index.rst index 30b19e7..4ca3611 100644 --- a/index.rst +++ b/index.rst @@ -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 From 72f2465fe98a816cff921c5058720aa937f06d48 Mon Sep 17 00:00:00 2001 From: Sipke Vriend Date: Mon, 22 Dec 2025 17:25:33 +1000 Subject: [PATCH 2/2] demos: add references to openamp-system-reference build documentation 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 --- demos/echo.rst | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/demos/echo.rst b/demos/echo.rst index da2e375..d564084 100644 --- a/demos/echo.rst +++ b/demos/echo.rst @@ -117,3 +117,17 @@ This Echo Test Sample is demonstrated in the following reference implementations * :ref:`Docker Images` as demo1A * :ref:`AMD-Xilinx platforms` * :ref:`Inter Process Demos` + + +.. 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 \ No newline at end of file