Module Verification Report extension#
score_module_verification_report provides the
.. module-verification-report:: directive, which expands into the
standard per-module verification report: a feature summary, a component
overview table, and one detailed section per component. Traceability is
resolved by sphinx-needs at render time — the directive only emits
.. needtable:: / .. needpie:: widgets with the right filters.
The extension is part of the score_sphinx_bundle. No external config file is required for the common case.
Typical usage (verification_report/module_verification_report.rst):
.. module-verification-report::
:module-id: mod__mymodule
:components: comp__mymodule_a, comp__mymodule_b
Options#
Option |
Required |
Description |
|---|---|---|
|
yes |
sphinx-needs id of the |
|
yes |
Comma-separated list of |
|
no |
sphinx-needs id of the |
|
no |
Prefix stripped from each component id to derive its slug (used
for section headings and document-id matching). Default:
|