Repository navigation
Preserve Markdown frontmatter and check documentation sources - #205
Merged
Merged
Conversation
Signed-off-by: Tim Paine <3105306+timkpaine@users.noreply.github.com>
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.
Preserve YAML frontmatter when formatting Markdown in all eight Python template variants by adding
mdformat-frontmatterto the generated develop extra. This keeps MyST page configuration, such asheading_anchors, from being rewritten as Markdown headings.Include existing
docs/srcdirectories in both formatting and spelling targets alongside README and optional wiki content. Use Make’s wildcard expansion so projects without that directory continue to lint and format successfully. Preserve Cython’s existingdocs/development.mdchecks.Generated all eight variants with docs/wiki enabled and disabled: 16 projects pass documentation checks with an absent source directory and a formatted frontmatter page. Deliberately malformed Markdown and misspellings fail lint, and
fix-docsrepairs them while preserving the YAML header. The generated pure-Python project also passes develop, lint, distribution-content checks, tests, and build.