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

DOC: html build of class docstrings without autosummary shows None #22398

Open
jorisvandenbossche opened this issue Aug 17, 2018 · 4 comments
Open
Labels

Comments

@jorisvandenbossche
Copy link
Member

We have some hacks to have class docstring pages without needing to build pages for all its methods/attributes.

For 0.22 docs this was working nicely:

https://pandas.pydata.org/pandas-docs/version/0.22.0/generated/pandas.Int64Index.html

But with 0.23, this now lists 'None' (which is a bit ugly on the page, but not a critical issue):

https://pandas.pydata.org/pandas-docs/version/0.23.0/generated/pandas.Int64Index.html

So we should investigate if something changes on pandas or sphinx side.
(the pandas docs sadly don't show the sphinx version it was built with)

@WillAyd
Copy link
Member

WillAyd commented Aug 17, 2018

Wondering if this is a sphinx bug. According to the docs the autoclass directive used in class_without_autosummary.rst "will by default only insert the docstring of the object itself"

http://www.sphinx-doc.org/en/1.5.1/ext/autodoc.html#directive-autoexception

but that doesn't appear to be the case with what you've shown above and with what we are seeing in #22359

@WillAyd
Copy link
Member

WillAyd commented Aug 17, 2018

Hmm maybe not on the sphinx side...just built locally with Sphinx 1.6.3 (released July 02, 2017 - quite a few months before v0.22 in December 2017) and still had the same issue

@jorisvandenbossche
Copy link
Member Author

@TomAugspurger do you by accident know with which sphinx versions you built the docs for pandas 0.22.0 and pandas 0.23.0 ?

@TomAugspurger
Copy link
Contributor

I'm not sure, and I apparently no longer have the docker image I used to build the docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants