Skip to content

Koma task safety reports integration#465

Draft
Komal362000 wants to merge 2 commits into
eclipse-score:mainfrom
Komal362000:koma_task_safety_reports_integration
Draft

Koma task safety reports integration#465
Komal362000 wants to merge 2 commits into
eclipse-score:mainfrom
Komal362000:koma_task_safety_reports_integration

Conversation

@Komal362000
Copy link
Copy Markdown
Contributor

@Komal362000 Komal362000 commented May 21, 2026

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:

File | What 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.

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.

@Komal362000 Komal362000 force-pushed the koma_task_safety_reports_integration branch from 8c68610 to a03b9bd Compare May 21, 2026 11:45
- 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
@Komal362000 Komal362000 force-pushed the koma_task_safety_reports_integration branch from a03b9bd to f4f66b5 Compare May 22, 2026 13:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant