fix build error for training files - #758
Merged
Merged
Conversation
RolandJentschETAS
requested review from
PandaeDo,
aschemmel-tech,
masc2023 and
pahmann
as code owners
August 3, 2026 09:58
Contributor
Author
|
See #757 |
|
The created documentation from the pull request is available at: docu-html |
PandaeDo
approved these changes
Aug 3, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request makes several improvements to the Sphinx training documentation build process and the structure of the training content files. The main changes include refining how certain files are excluded from the Sphinx build, updating metadata in Markdown files to improve navigation and suppress warnings, and enhancing the formatting of module and quiz links for consistency and compatibility.
Sphinx build configuration and file exclusion:
process/conf.pyto clarify thatexclude_patternsare not used directly; instead, file exclusion is handled in a Sphinx build hook, improving compatibility when building from other repositories. The previousexclude_patternssetting is now commented out with explanatory comments.Markdown metadata and navigation improvements:
orphan: trueandsuppress_warnings: ["myst.xref_missing"]metadata to theindex.mdfiles in both the requirements engineering training and the templates, as well asorphan: trueto all module and quiz files. This prevents Sphinx warnings about unreferenced pages and missing cross-references, making the build cleaner and navigation more robust. [1] [2] [3] [4] [5] [6] [7] [8] [9]Formatting and link consistency:
<a href="...">tags in both the requirements engineering and template trainingindex.mdfiles. This improves link rendering and compatibility with Sphinx/Myst parser. [1] [2]