Preserve MkDocs syntax during Markdown formatting - #176
Draft
hugosmoreira wants to merge 3 commits into
Draft
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
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.
Fixes #103
Summary
mdformat1.0.0 and addmdformat-mkdocs5.3.0 in Poetry and pre-commit.docstree, including the previously excludeddocs/apifiles.Plain
mdformatchanges both MkDocs admonitions and configuredmkdocstringsdirectives in ways that break their structure. Withmdformat-mkdocs, the same regression fixture is byte-for-byte unchanged.Validation
poetry check --lockmdformat README.md docs --checkExact pinned
pre-commit run mdformat --all-filesmkdocs build --clean(existing Griffe/link warnings remain)Generated HTML contains the expected rendered admonition and API documentation
git diff --checkFull Python test suite (the locked
tensorflow-io-gcs-filesystem==0.37.1has no compatible Windows wheel; Linux CI is the authoritative run)Appropriate changes to documentation are included in the PR