Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for docutils==0.20.x #1517

Merged
merged 3 commits into from Aug 29, 2023
Merged

Conversation

humitos
Copy link
Member

@humitos humitos commented Aug 25, 2023

Note that docutils==0.20.x is supported on Sphinx>=7.0.1

Closes #1516
Closes #1323
Closes #1336

@humitos
Copy link
Member Author

humitos commented Aug 25, 2023

I did the same visual QA test as in #1336 (comment) but using only Sphinx==7.2.x and I didn't find any visual difference.

Besides, we can see the changes in the HTML are pretty basic: https://gist.github.com/humitos/11dac3efa0ed0bca4bb4d06f5facc1f2

This PR is another good candidate for 2.x release -- cc @agjohnson

@humitos humitos marked this pull request as ready for review August 25, 2023 17:34
@humitos humitos requested a review from a team as a code owner August 25, 2023 17:34
Copy link
Collaborator

@agjohnson agjohnson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We talked a bit about going straight to 0.20 support on our 2.0rc1 candidate, we're still figuring out what is best here.

But testing this against previous docutils and the output is largely unchanged. I only noticed a different between a couple section headings between docutils 0.19 and 0.20, but 0.20 fixes what seem to be regressions in docutils 0.19.

@humitos
Copy link
Member Author

humitos commented Aug 29, 2023

I'm happy to move forward here and do a 2.0rc1, in particular if 0.19 has some regressions. There is no need to expose a version of our theme with docutils 0.19 if we already know they are fixed in 0.20.

I'm going to merge this PR so we can do a "rc" release today or tomorrow.

If you disagree with this decision, I'm happy to revert it 😄

@humitos humitos merged commit 5838e6a into master Aug 29, 2023
8 checks passed
@humitos humitos deleted the humitos/support-docutils-0-20 branch August 29, 2023 10:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Support for docutils 0.20.x Support for docutils 0.19.x
2 participants