From 2206a6c5424741cc2a445087966bbd532e55b209 Mon Sep 17 00:00:00 2001 From: Piotr Korkus Date: Tue, 27 Jan 2026 08:54:38 +0100 Subject: [PATCH 1/2] Add dead link checker --- src/incremental.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/incremental.py b/src/incremental.py index fbabf8b1..a498702d 100644 --- a/src/incremental.py +++ b/src/incremental.py @@ -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}") From 9b5d32621993806b8e13231457bbfe92cb796492 Mon Sep 17 00:00:00 2001 From: Piotr Korkus Date: Tue, 27 Jan 2026 09:41:54 +0100 Subject: [PATCH 2/2] fix broken links --- docs/internals/extensions/extension_guide.md | 1 - docs/internals/extensions/source_code_linker.md | 14 +++++++------- 2 files changed, 7 insertions(+), 8 deletions(-) diff --git a/docs/internals/extensions/extension_guide.md b/docs/internals/extensions/extension_guide.md index 74e14c2f..755e40b5 100644 --- a/docs/internals/extensions/extension_guide.md +++ b/docs/internals/extensions/extension_guide.md @@ -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) ## Adding a New Configuration Value diff --git a/docs/internals/extensions/source_code_linker.md b/docs/internals/extensions/source_code_linker.md index 2f53c840..c9d0a690 100644 --- a/docs/internals/extensions/source_code_linker.md +++ b/docs/internals/extensions/source_code_linker.md @@ -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. --- @@ -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} @@ -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