Skip to content

DOC/BLD: remove old sphinx pin #28804

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Oct 7, 2019
Merged

DOC/BLD: remove old sphinx pin #28804

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions environment.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
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.

- numpydoc>=0.9.0

# documentation (jupyter notebooks)
Expand Down
2 changes: 1 addition & 1 deletion requirements-dev.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ isort
mypy
pycodestyle
gitpython
sphinx==1.8.5
sphinx
numpydoc>=0.9.0
nbconvert>=5.4.1
nbsphinx
Expand Down