Repository navigation
Improve maintainability/quality of docs build by introducing product tests #628
Description
Improve High-Level Testing for Documentation
Problem Statement
While we have tests for individual components like extensions, we lack comprehensive high-level tests for our documentation system as a whole. This means integration issues may go unnoticed.
Missing Coverage
- Does PlantUML render correctly in
live_previewmode? - Is the source code linker triggered in
incrementalmode?
Scope of the Test
The goal is to validate the full integration of our documentation setup, ensuring that everything works together correctly. This includes:
- Bazel Integration: Ensuring our
.bzlfiles behave as expected. - Python Launcher Scripts: Verifying that our custom scripts work correctly.
- Sphinx and Extensions: Making sure Sphinx and our custom extensions function properly.
Test Approach
- The tests should replicate real user workflows as closely as possible.
- They should use the exact commands a user would run, such as
bazel run //docs:incremental
Activity
FScholPer commentedon May 21, 2025
@AlexanderLanin Do we have a fitting epic for that?
AlexanderLanin commentedon Jun 13, 2025
No we don't. We could create some "tools are tested" epic if that helps?
[-]docs: introduce product tests[/-][+]Improve maintainability/quality of docs build by introducing product tests[/+]MaximilianSoerenPollak commentedon Aug 14, 2025
Partially implemented via eclipse-score/docs-as-code#129
dcalavrezo-qorix commentedon Nov 27, 2025
Hi @AlexanderLanin,
Is this issue still relevant? If not, please add the
trashlabel so it can be marked for deletion.AlexanderLanin commentedon Dec 8, 2025
Covered by docs-as-code consumer tests