-
-
Notifications
You must be signed in to change notification settings - Fork 18.5k
DOC: fix no autosummary for numerical index api pages #17642
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: fix no autosummary for numerical index api pages #17642
Conversation
lgtm. merge when ready. |
Nope, it is not fixing the problem ... (not sure what causes it: for some reason the 'class_without_autosummary' template is not working for the numerical index classes, although it does work fine for eg CategoricalIndex which already used this long before) |
@jorisvandenbossche is it related to pandas/doc/sphinxext/numpydoc/numpydoc.py Line 45 in e0fe5cc
After the release, I hope to devote some time to getting us working with numpydoc proper and the most recent version of sphinx. |
Ah yes .. of course. Though I wrote that hack myself I think .. (so the template is actually not working)
Yes, that is also already a long time on my to do list, but never got to it. We have in the mean time quite some hacks like this added, but it would be nice to get it working with upstream (on sklearn they did a similar effort recently and pushed some changes upstream). Happy to help on it! |
Codecov Report
@@ Coverage Diff @@
## master #17642 +/- ##
==========================================
- Coverage 91.22% 91.2% -0.02%
==========================================
Files 163 163
Lines 49655 49655
==========================================
- Hits 45297 45288 -9
- Misses 4358 4367 +9
Continue to review full report at Codecov.
|
Codecov Report
@@ Coverage Diff @@
## master #17642 +/- ##
==========================================
- Coverage 91.22% 91.2% -0.02%
==========================================
Files 163 163
Lines 49655 49655
==========================================
- Hits 45297 45288 -9
- Misses 4358 4367 +9
Continue to review full report at Codecov.
|
This seems to be working now, so lets add some more hack and merge this. Thanks Tom for reminding me of the hack :-) |
For some reason the 'class_without_autosummary' template is not working for the newly added numeric index classes.
I asked in the PR #17611 to combine them, but now as a test splitting them again (all other cases where it does work is only one class, but if this works seems a bug in sphinx)
Don't merge yet.