Skip to content

Conversation

@jorisvandenbossche
Copy link
Member

@jorisvandenbossche jorisvandenbossche commented Oct 6, 2019

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.

@simonjayhawkins simonjayhawkins added this to the 1.0 milestone Oct 6, 2019
- 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
Copy link
Contributor

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?)

Copy link
Member Author

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.

@jorisvandenbossche
Copy link
Member Author

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).

@jorisvandenbossche jorisvandenbossche merged commit 7705cd2 into pandas-dev:master Oct 7, 2019
@jorisvandenbossche jorisvandenbossche deleted the doc-sphinx-version branch October 7, 2019 13:50
proost pushed a commit to proost/pandas that referenced this pull request Dec 19, 2019
proost pushed a commit to proost/pandas that referenced this pull request Dec 19, 2019
bongolegend pushed a commit to bongolegend/pandas that referenced this pull request Jan 1, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants