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

Building docs fails with the latest version of sphinx #19742

Closed
datapythonista opened this issue Feb 17, 2018 · 3 comments · Fixed by #19743
Closed

Building docs fails with the latest version of sphinx #19742

datapythonista opened this issue Feb 17, 2018 · 3 comments · Fixed by #19743
Labels
Build Library building on various platforms Docs
Milestone

Comments

@datapythonista
Copy link
Member

It seems like one week ago sphinx 1.7.0 was released, and the version of numpydoc included with pandas is not compatible with it (it uses the sphinx.util.compat which has been deprecated).

Anaconda already includes sphinx 1.7.0, which is used by default. As in requirements_dev.txt sphinx is specified without version, after following the instructions in the contributing documentation, building the documentation fails.

I assume that numpydoc has been modified, if included in the repository instead of being added as a dependency. So, may be a quick solution is to specify sphinx==1.6.7 in requirements_dev.txt.

Happy to contribute a pull request, if you can clarify what needs to be done.

@TomAugspurger
Copy link
Contributor

See #19687 and #18147

We're currently blocked by an IPython release to fix an issue with newer versions of the IPython directive. I thought we already pinned sphinx in our requirements_dev, but apparently not. We want to pin to sphinx 1.5.*, since 1.6 has a regression slowing down the API docs.

Alternatively, we could backport @jorisvandenbossche's fix to IPython and vendor that? I think pinning is best for now.

@jcontesti
Copy link
Contributor

When I install the build dependencies with pip, I get the following error:

python -m pip install -r ci/requirements_dev.txt
Invalid requirement: 'sphinx=1.5*'
= is not a valid operator. Did you mean == ?

Simply changing sphinx=1.5* with sphinx==1.5.* solves the issue.

Let me know if a can contribute with a PR.

@TomAugspurger
Copy link
Contributor

Sorry about that @jcontesti. I think #19687 is already addressing this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Build Library building on various platforms Docs
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants