gh-116546: Enable doctest to be run against markdown files
#116547
Closed
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.
Rationale
While core python uses reStructuredText, many packages maintain their documentation in markdown.
Doctest is currently unable to run against markdown files, or docstrings which use markdown to improve in-IDE rendering
Closes #116546 - see for full details.
Code change
Adjusted the regex used in doctest.DocTestParser to also consider
```to signify the end of an example block (in addition to a blank line and>>>).Dev Guide expectations
mainbranch, not suitable for a patch release./python -m testmake patchcheckdoctestcannot be used to test markdown files. #116546📚 Documentation preview 📚: https://cpython-previews--116547.org.readthedocs.build/