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

Require sphinx>4 #409

Closed
wants to merge 6 commits into from
Closed

Conversation

jarrodmillman
Copy link
Member

@jarrodmillman jarrodmillman commented Jun 8, 2022

In #385, we tentatively agreed to drop support for sphinx 3 with numpy 1.4. We are releasing 1.4 a little sooner than planned.

However, the 1.4 release mainly adds support for new versions of docutils. So for folks using sphinx 3, then there is no reason for them to use numpydoc 1.4. Moreover, pydata-sphinx-theme and myst-parser have dropped support for sphinx 3 with their recent releases. Finally, in #393, you can see that numpydoc doesn't support sphinx ~= 3.5 under python 3.10 and above. You can also see in 6108474 that we require sphinx >= 4.2 under python 3.10 and above (see sphinx-doc/sphinx#9562 for more information).

Maybe it is too aggressive, but I think it may make sense to require sphinx >= 4.2.

  • sphinx 4.0.2 released May 20, 2021
  • sphinx 4.2 released Sept 12, 2021

If we only require sphinx>=4.0.2, how should we document that for Python 3.10+ we require sphinx>=4.2?

Thoughts?

@jarrodmillman jarrodmillman added this to the 1.4.0 milestone Jun 8, 2022
@jarrodmillman jarrodmillman mentioned this pull request Jun 8, 2022
3 tasks
@jarrodmillman jarrodmillman mentioned this pull request Jun 9, 2022
@jarrodmillman
Copy link
Member Author

jarrodmillman commented Jun 9, 2022

@larsoner @rossbar Does this look OK? Should we require sphinx >= 4.2, since earlier versions don't work on Python 3.10+?

Alternatively, we could continue supporting 3.0-3.4 for Python < 3.10 (see #410) and then we could merge this after releasing numpydoc 1.4.

@larsoner
Copy link
Collaborator

larsoner commented Jun 9, 2022

+1 for cutting a release of 1.4 then merging this and supporting >=4.2 only

@jarrodmillman jarrodmillman modified the milestones: 1.4.0, 1.5.0 Jun 9, 2022
@jarrodmillman jarrodmillman mentioned this pull request Jun 9, 2022
@jarrodmillman jarrodmillman removed this from the 1.5.0 milestone Jun 9, 2022
@jarrodmillman jarrodmillman deleted the drop-sphinx-3 branch September 28, 2022 05:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants