chore: build docs from single-source community files #1005
Merged
Conversation
Signed-off-by: Lars Schilders <lars.schilders@alliander.com>
Signed-off-by: Lars Schilders <lars.schilders@alliander.com>
egordm
previously approved these changes
Jun 25, 2026
egordm
left a comment
Collaborator
There was a problem hiding this comment.
Looks good. Maybe recheck if files already exist would be nice. Otherwise approved.
Signed-off-by: Lars Schilders <123180911+lschilders@users.noreply.github.com>
Signed-off-by: Lars Schilders <lars.schilders@alliander.com>
|
egordm
approved these changes
Jun 25, 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 streamlines how community documents (like the Code of Conduct and Contributing Guide) are integrated into the documentation and improves cross-referencing and navigation within the docs. The main changes involve removing duplicated Markdown files from the repository, updating the Sphinx configuration to better handle included Markdown, and simplifying the documentation source files to include the community files from a single source of truth.
Community file management and documentation integration:
.github/CODE_OF_CONDUCT.mdand.github/CONTRIBUTING.mdfiles from the repository, ensuring these are now materialized into the docs at build time from the org-level OpenSTEF/.github repository, and included in the documentation via the_community/directory. [1] [2]docs/source/contribute/code_of_conduct.rstanddocs/source/contribute/contributing_guide.rstto include the respective Markdown files from_community/using the MyST parser, rather than maintaining separate RST content. [1] [2]Sphinx documentation build improvements:
sphinx.ext.autosectionlabelextension indocs/source/conf.pyto automatically generate unique cross-reference labels for every section heading, making it easier to deep-link into included Markdown documents. Also, configured Sphinx to suppress duplicate label warnings and to exclude_community/files from source discovery. [1] [2] [3]myst_heading_anchors = 4indocs/source/conf.py, ensuring intra-page links in included Markdown files work as expected.Documentation navigation and linking updates:
docs/source/contribute/index.rstto use the new autosectionlabel-prefixed section references, ensuring that navigation cards and references point to the correct sections in the included community documents. [1] [2]