-
-
Notifications
You must be signed in to change notification settings - Fork 18.2k
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
DOC/BLD: remove old sphinx pin #28804
DOC/BLD: remove old sphinx pin #28804
Conversation
@@ -27,8 +27,7 @@ dependencies: | |||
|
|||
# documentation | |||
- gitpython # obtain contributors from git for whatsnew | |||
# some styling is broken with sphinx >= 2 (https://github.com/pandas-dev/pandas/issues/26058) | |||
- sphinx=1.8.5 | |||
- sphinx |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should we have a min sphinx now, e.g. sphinx>=2.0.0? (also do we need to update contributing.rst?)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's not that the the docs are not building with the older sphinx version, so it's not a hard requirement (there is only some javascript based functionality that is not working, but which is not important for people contributing to the docstrings)
In the contributing guide we don't mention anything about the sphinx version currently.
I am going to merge this, and leave the minimum sphinx version for later. With the new theme development, we still need to check somewhat the minimum sphinx requirements for the sphinx features we are using, so let's revisit this a bit later when having a better idea on this (the theme python package should then also enforce such a minimum version, which is not yet the case). |
xref #26058 and pydata/pydata-sphinx-theme#25
We need a newer sphinx version for the new theme. There were some styling issues with the parameter listings on the docstring API pages, but those probably need to redesigned anyway with the new theme.