Repository navigation
docs: render markdown headings relative to their section - #397
Open
yeoldegrove wants to merge 2 commits into
Open
yeoldegrove wants to merge 2 commits into
yeoldegrove wants to merge 2 commits into
Conversation
Contributor
Author
|
@NotTheEvilOne I am planing |
|
📚 Documentation Preview PR: gardenlinux/docs#241 A PR has been created/updated to preview the documentation changes from this PR. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #397 +/- ##
=======================================
Coverage 91.56% 91.56%
=======================================
Files 51 51
Lines 3155 3155
=======================================
Hits 2889 2889
Misses 266 266 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
sphinx-markdown-builder pins rubric and option/signature headings to level 3 while section titles use their absolute nesting depth. Nested sphinx-click and sphinxcontrib-autoprogram sections therefore jump from level 3 to 5 in the generated markdown, which the aggregated docs reject (gldq HEAD-SKIP). Override the markdown translator so those headings are rendered one level below the enclosing section, keeping the API class/method layout unchanged. Signed-off-by: Eike Waldt <waldt@b1-systems.de> On-behalf-of: SAP <eike.waldt@sap.com> Assisted-by: Kilo:claude-sonnet-4-6
yeoldegrove
force-pushed
the
docs/gldq
branch
from
November 11, 2026 15:57
03ded4c to
705703d
Compare
Signed-off-by: Eike Waldt <waldt@b1-systems.de> On-behalf-of: SAP <eike.waldt@sap.com>
This branch has not been deployed
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.
What this PR does / why we need it:
sphinx-markdown-builder pins rubric and option/signature headings to level 3 while section titles use their absolute nesting depth. Nested sphinx-click and sphinxcontrib-autoprogram sections therefore jump from level 3 to 5 in the generated markdown, which the aggregated docs reject (gldq HEAD-SKIP).
Override the markdown translator so those headings are rendered one level below the enclosing section, keeping the API class/method layout unchanged.