-
-
Notifications
You must be signed in to change notification settings - Fork 18.1k
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: test new sphinx 2 release #26058
Comments
I think the anaconda version is still 1.8.5. |
Yes, but we are also listing conda-forge as a second channel, and there it is already updated, so I would expected the environment solver to get the newest version from there. Anyway, it is installing 1.8.5 on travis, that's the relevant part here ;) |
Yes. I agree. I manually installed version 2.0.1 on local and creating a doc build now. |
BTW, Sphinx 2.0.1 is part of conda now. And our doc build are using v 2.0.1 to build docs. I do not think there are any issues with the upgrade. |
Ah, thanks for noticing! I see one "RemovedInSphinx30Warning" in the logs, but that is probably coming from nbsphinx. For the rest everything indeed seems fine. |
One thing I am noticing is that the API pages lost a bit of their styling. Compare http://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.melt.html#pandas-melt with http://pandas-docs.github.io/pandas-docs-travis/reference/api/pandas.melt.html#pandas-melt It seems sphinx changes how field lists are converted to html, so our custom css (in doc/source/themes/nature_with_gtoc/static/nature.css_t) is no longer matching that. |
Also whole bunch of warnings |
Yes, but those are not new. They will go away once a new nbconvert release is out, so we can ignore them for now |
So with sphinx 1.8.5, you get something like (for the Parameters section of the pandas.melt docstring):
while with sphinx 2.0, it is now:
So before, there was a html table with So it might be that with readthedocs there is a similar issue. |
so not sure if this is applicable, but on http://pandas-docs.github.io/pandas-docs-travis/reference/indexing.html is now center justified and was left justified in 0.24.2. (probably would be better to be full width) also have extra backslashes for the *args, **kwargs |
Yep, that seem to be yet some more theme issues with the latest sphinx ... Some others are the one I mentioned above, and also the too much white space in the in-page table of contents, eg at http://pandas-docs.github.io/pandas-docs-travis/development/contributing.html |
Another thing I noticed is that the API pages now include self in the signature (not sure it is related to sphinx 2.x), but at least it is something present in the dev docs and not stable docs. Eg http://pandas-docs.github.io/pandas-docs-travis/reference/api/pandas.DataFrame.mean.html vs http://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.mean.html#pandas.DataFrame.mean |
From a quick test, this does not seem to be related to sphinx above or below 2.0, but also couldn't point it something else (eg version of numpydoc) Update -> this is caused by numpydoc regression: numpy/numpydoc#220 |
Looks like we're using Sphinx 3 now in our doc builds. Don't think Sphinx 2 issues are relevant anymore, but happy to open a new issue to discuss if there are any Sphinx 3 issues that we're experiencing |
The docs are currently being built with sphinx 1.8.5 (see eg https://travis-ci.org/pandas-dev/pandas/jobs/518832177 for a recent build on master).
Sphinx has released 2.0.0 (http://www.sphinx-doc.org/en/master/changes.html#release-2-0-0-released-mar-29-2019), and it would be good to test our docs with this new release, and see if we need to make changes / report regressions to sphinx.
For somebody wanting to tackle this:
The text was updated successfully, but these errors were encountered: