Bump docutils to >=0.22.2 and update test fixtures #3552
Closed
+9,230
−9,232
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
This fixes a compatibility issue between code changes from PR getpelican#3510 and the docutils dependency specification. ## Background On Oct 9, 2025 (commit 5acf155 / PR getpelican#3510), code in pelican/readers.py was changed to pass string arguments directly to the docutils.core.Publisher() constructor instead of using set_components() method. This change requires docutils >= 0.22. On Oct 15, 2025 (commit yxtmxopu), the pyproject.toml requirement was reverted from >=0.22.2 back to >=0.20.1 due to dependency conflicts with Sphinx, BUT the code changes were NOT reverted. This left the codebase in an inconsistent state where the code required docutils 0.22+ but the dependency spec allowed 0.20.1. ## Changes 1. **pyproject.toml**: - Updated docutils requirement from >=0.20.1 to >=0.22.2 - Removed Sphinx, sphinxext-opengraph, and furo from dev dependencies (they remain in requirements/docs.pip for documentation builds) - Rationale: Sphinx < 9.0 requires docutils < 0.22, but Sphinx >= 9.0 requires Python >= 3.12 (conflicts with Pelican's support for Python >= 3.10) 2. **requirements/docs.pip**: - Added 'roman' package to fix Sphinx 7.x dependency issue 3. **pelican/tests/output/**: - Regenerated all expected test output files using docutils 0.22.4 - Changes reflect new XML formatting (self-closing tags) and HTML formatting (whitespace handling in syntax-highlighted code blocks) 4. **regenerate_test_output.py**: - Added utility script for regenerating test fixtures - Fixed path issue where script was using wrong content directory ## Testing - All 303 tests pass with docutils 0.22.4 - Documentation builds successfully with tox -e docs
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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 fixes a compatibility issue between code changes from PR #3510 and the docutils dependency specification.
Background
On Oct 9, 2025 (commit 5acf155 / PR #3510), code in pelican/readers.py was changed to pass string arguments directly to the docutils.core.Publisher() constructor instead of using set_components() method. This change requires docutils >= 0.22.
On Oct 15, 2025 (commit yxtmxopu), the pyproject.toml requirement was reverted from >=0.22.2 back to >=0.20.1 due to dependency conflicts with Sphinx, BUT the code changes were NOT reverted. This left the codebase in an inconsistent state where the code required docutils 0.22+ but the dependency spec allowed 0.20.1.
Testing
Pull Request Checklist
Resolves: #issue-number-here