Skip to content

Add need-Id tag for linking source code to architecture / detailed de… #330

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

Open
PhilipPartsch wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add need-Id tag for linking source code to architecture / detailed de… #330

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
78cf0a9
Add need-Id tag for linking source code to architecture / detailed de…
PhilipPartsch Dec 15, 2025
6e4f428
Add 'need-Id' reference option to documentation
PhilipPartsch Dec 15, 2025
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
3 changes: 2 additions & 1 deletion docs/how-to/source_to_doc_links.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,13 @@ Reference Docs in Source Code
In your C++/Rust/Python source code, you want to reference requirements (needs).
The docs-as-code tool will create backlinks in the documentation.

Use a comment and start with ``req-Id:`` or ``req-traceability:`` followed by the need ID.
Use a comment and start with ``req-Id:``, ``req-traceability:`` or ``need-Id:`` followed by the need ID.

.. code-block:: python

# req-Id: TOOL_REQ__EXAMPLE_ID
# req-traceability: TOOL_REQ__EXAMPLE_ID
# need-Id: TOOL_REQ__EXAMPLE_ID

For an example, look at the attribute ``source_code_link``
of :need:`tool_req__docs_common_attr_title`.
1 change: 1 addition & 0 deletions src/extensions/score_source_code_linker/generate_source_code_links_json.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
TAGS = [
"# " + "req-traceability:",
"# " + "req-Id:",
"# " + "need-Id:", # to link from source code to architecture element
]


Expand Down
Loading