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

2.0 milestone: drop supported versions #1500

Merged
merged 13 commits into from
Aug 21, 2023

Conversation

humitos
Copy link
Member

@humitos humitos commented Aug 10, 2023

The new policy is:

  • Python >=3.6
  • Sphinx >= 5
  • HTML4 and HTML5 writer
  • docutils >= 0.14, < 0.19

@humitos humitos requested a review from a team as a code owner August 10, 2023 10:48
@humitos humitos force-pushed the humitos/drop-supported-versions branch from 6e4950d to e32540c Compare August 10, 2023 10:50
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.

This doesn't quite match what Sphinx 5 supports, so I don't think we should make all of these changes. I would be in favor of more aggressive tuning on what we visually test against -- mostly Python versions really, but perhaps docutils versions too.

Once our support matrix drops Sphinx 5 these will get tighter, but I think 5 usage is still high enough to warrant support. We're just at an unfortunate stage where our dependency graph and Sphinx's dependency graph is very wide still.

docs/development.rst Outdated Show resolved Hide resolved
setup.cfg Outdated Show resolved Hide resolved
setup.cfg Outdated Show resolved Hide resolved
tox.ini Outdated Show resolved Hide resolved
tox.ini Show resolved Hide resolved
@humitos humitos requested a review from agjohnson August 17, 2023 09:40
The new policy is:

- Python >=3.6
- Sphinx >= 5
- HTML4 and HTML5 writer
- docutils >= 0.14, < 0.19
By the beginning of 2024 we should support newer Sphinx versions and HTML5 only.
@humitos humitos force-pushed the humitos/drop-supported-versions branch from b625bfb to 136b275 Compare August 17, 2023 09:42
@humitos
Copy link
Member Author

humitos commented Aug 17, 2023

@agjohnson I updated this PR with the changes suggested. Let me know if you OK with this. I'd be happy to move forward and get closer to a 2.0 release 🚀

@humitos humitos closed this Aug 17, 2023
@humitos humitos reopened this Aug 17, 2023
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.

Looks really close. I noted a couple of minor tox tweaks for this release.

tox.ini Outdated Show resolved Hide resolved
- drop support for HTML4 on 2.0
- keep `-qa` TOX environment to be able to compare feature branches
- emit `logger.errors` on Python 2 and html_writer4=True
- require Sphinx >= 5.0
- remove logic for old Sphinx versions
@humitos
Copy link
Member Author

humitos commented Aug 18, 2023

@agjohnson I updated this PR with some changes from your feedback.

@humitos humitos requested a review from agjohnson August 18, 2023 10:50
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.

This looks great. Lets plan on getting a final 1.3.0 out before we merge this here, perhaps on Mon/Tues?

@agjohnson agjohnson merged commit 0e7b28a into master Aug 21, 2023
8 checks passed
@agjohnson agjohnson deleted the humitos/drop-supported-versions branch August 21, 2023 18:38
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.

Reduce supported versions and release plan Drop html4 testing, remove support for html4writer
2 participants