Skip to content

[rules score] enhance docs build #218

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
castler merged 1 commit into from
May 13, 2026
Merged

[rules score] enhance docs build #218

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
0 .../seooc/safety_analysis/safety_analysis.md → ...rules/rules_score/docs/safety_analysis.md
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion bazel/rules/rules_score/private/architectural_design.bzl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ def _architectural_design_impl(ctx):
# toctree entry in the dependable_element index.
rst_wrappers = make_puml_rst_wrappers(
ctx,
ctx.files.static + ctx.files.dynamic,
ctx.files.static + ctx.files.dynamic + ctx.files.public_api,
ctx.label.name,
ctx.file._puml_rst_template,
)
Expand Down
23 changes: 20 additions & 3 deletions bazel/rules/rules_score/templates/dependable_element_index.template.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,27 +19,44 @@ Assumed System
--------------

.. toctree::
:maxdepth: 2
:maxdepth: 1
:caption: Assumed System Requirements

{assumed_system_requirements}

.. toctree::
:maxdepth: 1
:caption: Assumptions of Use

{assumptions_of_use}

Software Architectural Level
----------------------------

.. toctree::
:maxdepth: 2
:maxdepth: 1
:caption: Feature Requirements

{feature_requirements}

.. toctree::
:maxdepth: 1
:caption: Architectural Design

{architectural_design}

.. toctree::
:maxdepth: 1
:caption: Dependability Analysis

{dependability_analysis}


Components
----------

.. toctree::
:maxdepth: 2
:maxdepth: 1

{components}

Expand Down
13 changes: 9 additions & 4 deletions bazel/rules/rules_score/trlc/config/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Type Hierarchy
├── description: String
├── version: Integer
├── note: optional String
├── status: Status {valid, invalid}
├── status: Status {valid, invalid} -- frozen to "valid"
│
└── RequirementSafety (abstract, extends Requirement)
├── safety: Asil {QM, B, D}
Expand All @@ -36,10 +36,12 @@ Type Hierarchy
│ └── rationale: String
│
├── FeatReq
│ └── derived_from: list of ReqId
│ └── derived_from: AssumedSystemReqId[1..*]
│
└── CompReq
└── derived_from: list of ReqId
├── derived_from (optional): FeatReqId[1..*]
├── fulfilledBy (optional): String
└── mitigates (optional): String

Usage
-----
Expand All @@ -59,6 +61,9 @@ Reference this metamodel as ``spec`` in ``trlc_requirements`` rules:
Traceability
------------

``ReqId`` tuples (e.g., ``FeatReq.derived_from``) connect requirements across levels:
Typed tuple IDs connect requirements across levels:
``AssumedSystemReq`` → ``FeatReq`` → ``CompReq``, forming the traceability chain
enforced by LOBSTER at the dependable-element level.

- ``FeatReq.derived_from`` accepts ``AssumedSystemReqId`` tuples (mandatory)
- ``CompReq.derived_from`` accepts ``FeatReqId`` tuples (optional)
Loading