⬆️ Allow docutils 0.22 #1084
Merged
⬆️ Allow docutils 0.22 #1084
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
There was a problem hiding this comment.
Pull request overview
This PR updates the project to support docutils 0.22 by adapting to breaking changes in how docutils serializes boolean attributes and line numbers. The changes ensure test compatibility across docutils versions 0.20-0.22.
Changes:
- Updated docutils version constraint from
<0.22to<0.23 - Introduced
normalize_doctree_xml()function to handle cross-version XML serialization differences - Updated test fixtures to reflect docutils 0.22's line numbering changes
Reviewed changes
Copilot reviewed 19 out of 19 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| pyproject.toml | Updated docutils version constraint and added pytest warning filter |
| tests/conftest.py | Added normalize_doctree_xml() function for cross-version compatibility |
| myst_parser/mocking.py | Added handling for docutils 0.22's integer number-lines option |
| tests/test_sphinx/conftest.py | Applied normalization to doctree formatting |
| tests/test_sphinx/test_sphinx_builds.py | Applied normalization and added import |
| tests/test_renderers/*.py | Applied normalization across all renderer tests |
| tests/test_html/test_html_to_nodes.py | Applied normalization to HTML node tests |
| tests/test_renderers/fixtures/*.txt | Updated test fixtures for docutils 0.22 behavior |
| tests/test_sphinx/sourcedirs/includes/index.md | Changed line numbering from 0 to 1 |
| tests/test_sphinx/test_sphinx_builds/test_includes.* | Updated expected output for new line numbering |
| AGENTS.md | Added documentation note and docutils release log link |
| .github/workflows/tests.yml | Added docutils 0.22 to test matrix |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This was referenced Jan 15, 2026
Closed
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.
This PR updates the project to support docutils 0.22 by adapting to breaking changes in how docutils serializes boolean attributes and line numbers. The changes ensure test compatibility across docutils versions 0.20-0.22.
Changes:
<0.22to<0.23normalize_doctree_xml()function to handle cross-version XML serialization differencesNote, one issue was found and raised upstream: sphinx-doc/sphinx#14261