From f4f66b55d6e4fe8bdef489c543d70193faae88bc Mon Sep 17 00:00:00 2001 From: komal mahale Date: Thu, 21 May 2026 17:09:52 +0530 Subject: [PATCH 1/2] docs: integrate safety reports into main Sphinx navigation - Add safety_message_passing.rst and safety_mw_com.rst as Sphinx pages - Embed external HTML reports via iframe so report is shown directly - Update safety_reports.rst to use toctree instead of plain HTML links - Update BUILD to include new RST source files - Fixes navigation loss when clicking safety report links --- docs/sphinx/BUILD | 2 ++ docs/sphinx/safety_message_passing.rst | 11 +++++++++++ docs/sphinx/safety_mw_com.rst | 11 +++++++++++ docs/sphinx/safety_reports.rst | 20 ++++++++------------ 4 files changed, 32 insertions(+), 12 deletions(-) create mode 100644 docs/sphinx/safety_message_passing.rst create mode 100644 docs/sphinx/safety_mw_com.rst diff --git a/docs/sphinx/BUILD b/docs/sphinx/BUILD index 2343ac385..b2379e2e5 100644 --- a/docs/sphinx/BUILD +++ b/docs/sphinx/BUILD @@ -57,6 +57,8 @@ sphinx_module( "introduction.rst", "message_passing.rst", "safety_reports.rst", + "safety_message_passing.rst", + "safety_mw_com.rst", ":doxygen_xml", ":generate_api_rst", ":static_assets", diff --git a/docs/sphinx/safety_message_passing.rst b/docs/sphinx/safety_message_passing.rst new file mode 100644 index 000000000..012544f75 --- /dev/null +++ b/docs/sphinx/safety_message_passing.rst @@ -0,0 +1,11 @@ +Message Passing Safety Report +============================== + +.. raw:: html + + diff --git a/docs/sphinx/safety_mw_com.rst b/docs/sphinx/safety_mw_com.rst new file mode 100644 index 000000000..06e236dea --- /dev/null +++ b/docs/sphinx/safety_mw_com.rst @@ -0,0 +1,11 @@ +MW::COM Safety Report +====================== + +.. raw:: html + + diff --git a/docs/sphinx/safety_reports.rst b/docs/sphinx/safety_reports.rst index e04105de6..a0c4b731e 100644 --- a/docs/sphinx/safety_reports.rst +++ b/docs/sphinx/safety_reports.rst @@ -1,15 +1,11 @@ Safety Reports ============== -Safety documentation reports - -.. list-table:: - :widths: 30 70 - :header-rows: 1 - - * - Report - - Description - * - `Message Passing `_ - - Dependable Element - * - `MW::COM `_ - - Dependable Element +Safety documentation reports for the S-CORE communication components. + +.. toctree:: + :maxdepth: 1 + + safety_message_passing + safety_mw_com + From 7e8cfc7e364cf280639d9df801b234789b7fff1a Mon Sep 17 00:00:00 2001 From: komal mahale Date: Mon, 25 May 2026 16:35:01 +0530 Subject: [PATCH 2/2] docs: show safety reports overview table with hidden toctree navigation --- docs/sphinx/safety_reports.rst | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/docs/sphinx/safety_reports.rst b/docs/sphinx/safety_reports.rst index a0c4b731e..86ca4943b 100644 --- a/docs/sphinx/safety_reports.rst +++ b/docs/sphinx/safety_reports.rst @@ -3,8 +3,19 @@ Safety Reports Safety documentation reports for the S-CORE communication components. +.. list-table:: + :widths: 30 70 + :header-rows: 1 + + * - Report + - Description + * - :doc:`safety_message_passing` + - Dependable Element + * - :doc:`safety_mw_com` + - Dependable Element + .. toctree:: - :maxdepth: 1 + :hidden: safety_message_passing safety_mw_com