Skip to content

fix build error for training files - #758

Merged
PandaeDo merged 1 commit into
eclipse-score:mainfrom
etas-contrib:fix_training_file_error
Aug 3, 2026
Merged

fix build error for training files#758
PandaeDo merged 1 commit into
eclipse-score:mainfrom
etas-contrib:fix_training_file_error

Conversation

@RolandJentschETAS

Copy link
Copy Markdown
Contributor

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:

  • Updated process/conf.py to clarify that exclude_patterns are not used directly; instead, file exclusion is handled in a Sphinx build hook, improving compatibility when building from other repositories. The previous exclude_patterns setting is now commented out with explanatory comments.

Markdown metadata and navigation improvements:

  • Added orphan: true and suppress_warnings: ["myst.xref_missing"] metadata to the index.md files in both the requirements engineering training and the templates, as well as orphan: true to 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:

  • Changed Markdown links for modules and quizzes in the overview tables to HTML <a href="..."> tags in both the requirements engineering and template training index.md files. This improves link rendering and compatibility with Sphinx/Myst parser. [1] [2]

@RolandJentschETAS

Copy link
Copy Markdown
Contributor Author

See #757

@github-actions

github-actions Bot commented Aug 3, 2026

Copy link
Copy Markdown

The created documentation from the pull request is available at: docu-html

@PandaeDo
PandaeDo merged commit b485d01 into eclipse-score:main Aug 3, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants