Koma task safety reports integration#465
Conversation
a03b9bd to
f4f66b5
Compare
b7f51b7 to
863c4eb
Compare
|
Code written is right but the feature wise i would suggest not Good to go. we not make report inside report. we go inside the report and return back the main page. this is the right approach for my understanding. |
|
Take a reference for public API in same doc. |
|
#465 (comment) My understanding from Jochen guidance was that each Safety Report should open as its own page when clicked. Based on that, I followed the same navigation pattern used in the Public API reference and implemented it in this PR. After rechecking, I found one issue that still needs improvement: when clicking a Safety Report, the page source/context is not shown as expected compared to the earlier behavior. I will work on this and update the PR accordingly. |
bebad76 to
50e94ac
Compare
50e94ac to
d3d7606
Compare
|
The idea is not to have an "i-frame" but rather to have the safety reports as "sub-categories" IMHO |
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.