Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 0 additions & 1 deletion docs/internals/extensions/extension_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,6 @@ Some events also expect a return value.
For more information, please see the related documentation:
- [Attaching function signature](https://www.sphinx-doc.org/en/master/extdev/appapi.html#sphinx.application.Sphinx.connect)
- [Build API events](https://www.sphinx-doc.org/en/master/extdev/event_callbacks.html#core-events-overview)
- [sphinx-needs events](https://github.com/useblocks/sphinx-needs/blob/master/docs/contributing.rst#structure-of-the-extensions-logic)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed outdated "Structure of the extension's logic" section from contributing documentation, deferring to AGENTS.md instead
useblocks/sphinx-needs#1621


## Adding a New Configuration Value

Expand Down
14 changes: 7 additions & 7 deletions docs/internals/extensions/source_code_linker.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
(source-code-linker)=
# Score Source Code Linker

A Sphinx extension for enabling **source code and test traceability** for requirements.
A Sphinx extension for enabling **source code and test traceability** for requirements.
This extension integrates with **Bazel** and **sphinx-needs** to automatically generate traceability links between implementation, tests, and documentation.

---
Expand Down Expand Up @@ -218,10 +218,10 @@ rm -rf _build/
## Examples:
To see working examples for CodeLinks & TestLinks, take a look at the Docs-As-Code documentation.

[Example CodeLink](https://eclipse-score.github.io/docs-as-code/main/requirements/requirements.html#tool_req__docs_common_attr_id_scheme)
[Example CodeLink](https://eclipse-score.github.io/docs-as-code/main/requirements/requirements.html#tool_req__docs_common_attr_status)
[Example CodeLink](https://eclipse-score.github.io/docs-as-code/main/internals/requirements/requirements.html#tool_req__docs_common_attr_id_scheme)
[Example CodeLink](https://eclipse-score.github.io/docs-as-code/main/internals/requirements/requirements.html#tool_req__docs_common_attr_status)

[Example TestLink](https://eclipse-score.github.io/docs-as-code/main/requirements/requirements.html#tool_req__docs_dd_link_source_code_link)
[Example TestLink](https://eclipse-score.github.io/docs-as-code/main/internals/requirements/requirements.html#tool_req__docs_dd_link_source_code_link)

## Flow-Overview
```{mermaid}
Expand Down Expand Up @@ -272,9 +272,9 @@ flowchart TD
L4[DTFL = DataForTestLink]
L3[TestCaseNeed Operations]
L5[DOTC = DataOfTestCase]
L1 ~~~ L2
L2 ~~~ L4
L4 ~~~ L3
L1 ~~~ L2
L2 ~~~ L4
L4 ~~~ L3
L3 ~~~ L5
end

Expand Down
2 changes: 1 addition & 1 deletion src/incremental.py
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ def get_env(name: str) -> str:
if action == "incremental":
builder = "html"
elif action == "check":
builder = "needs"
builder = "linkcheck"
else:
raise ValueError(f"Unknown action: {action}")

Expand Down
Loading