Koma task safety reports integration#465
Draft
Komal362000 wants to merge 2 commits into
Draft
Conversation
8c68610 to
a03b9bd
Compare
- 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
a03b9bd to
f4f66b5
Compare
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Problem:
Clicking safety report links opened a standalone HTML page, losing all Sphinx navigation.
Solution:
Added a dedicated RST page per report so they appear as proper Sphinx pages with full navigation. This is a Sphinx requirement — every left sidebar entry must have its own RST file.
Why not auto-generate?
Auto-generation only makes sense when there is real logic involved (e.g. parsing 100+ C++ items). Here each file is just a title + one iframe — writing a Bazel rule for that adds more complexity than it saves.
Files changed:
Result: Left sidebar now shows "Safety Reports → Message Passing / MW::COM", report content only appears after clicking, Sphinx navigation never lost.
Problem: Clicking safety report links opened a standalone HTML page, losing all Sphinx navigation.Solution:
Added a dedicated RST page per report so they appear as proper Sphinx pages with full navigation. This is a Sphinx requirement — every left sidebar entry must have its own RST file.
Why not auto-generate?
Auto-generation only makes sense when there is real logic involved (e.g. parsing 100+ C++ items). Here each file is just a title + one iframe — writing a Bazel rule for that adds more complexity than it saves.
Files changed:
BUILD — Added 2 new RST files to sphinx sources
safety_reports.rst — Overview table with links + hidden toctree for left sidebar
safety_message_passing.rst — New page showing Message Passing report via iframe
safety_mw_com.rst — New page showing MW::COM report via iframe
Result: Left sidebar now shows "Safety Reports → Message Passing / MW::COM", report content only appears after clicking, Sphinx navigation never lost.