Migrate to markdown-code-runner's built-in include_section() #1417
Conversation
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
Replace custom docs_gen.py with markdown-code-runner's built-in include_section() function for extracting content from README.md. Changes: - Remove custom_components/adaptive_lighting/docs_gen.py - Update all docs/*.md files to use include_section() instead of readme_section() - Update pyproject.toml to use git version of markdown-code-runner (until v2.7.0 is released with include_section support) The include_section() function provides the same functionality as readme_section() - extracting content between SECTION markers and optionally stripping the first heading.
The _transform_readme_links() function was needed to transform README internal anchor links (like #gear-configuration) to docs site links (like configuration.md). This restores the function and updates all docs files that use include_section() with README.md to apply the transformation.
Use single-line comment format for each code line instead of multi-line blocks. The markdown-code-runner expects `<!-- code -->` on each line, not `<!--\ncode\n-->` blocks.
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.
Summary
docs_gen.pywith markdown-code-runner's built-ininclude_section()functioncustom_components/adaptive_lighting/docs_gen.py(84 lines removed)include_section()instead ofreadme_section()Changes
The built-in
include_section(file, name, strip_heading=False)function provides the same functionality as the customreadme_section():<!-- SECTION:name:START -->and<!-- SECTION:name:END -->markersstrip_heading=TrueTest plan
markdown-code-runneron all docs files