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: fix no autosummary for numerical index api pages #17642

Merged

Conversation

jorisvandenbossche
Copy link
Member

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.

@jorisvandenbossche jorisvandenbossche added this to the 0.21.0 milestone Sep 23, 2017
@pandas-dev pandas-dev deleted a comment from codecov bot Sep 23, 2017
@pandas-dev pandas-dev deleted a comment from codecov bot Sep 23, 2017
@pandas-dev pandas-dev deleted a comment from codecov bot Sep 23, 2017
@jreback
Copy link
Contributor

jreback commented Sep 23, 2017

lgtm. merge when ready.

@jorisvandenbossche
Copy link
Member Author

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)

@TomAugspurger
Copy link
Contributor

@jorisvandenbossche is it related to

# PANDAS HACK (to remove the list of methods/attributes for Categorical)
?

After the release, I hope to devote some time to getting us working with numpydoc proper and the most recent version of sphinx.

@jorisvandenbossche
Copy link
Member Author

Ah yes .. of course. Though I wrote that hack myself I think .. (so the template is actually not working)

After the release, I hope to devote some time to getting us working with numpydoc proper and the most recent version of sphinx.

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
Copy link

codecov bot commented Sep 25, 2017

Codecov Report

Merging #17642 into master will decrease coverage by 0.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            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
Flag Coverage Δ
#multiple 88.99% <ø> (ø) ⬆️
#single 40.17% <ø> (-0.07%) ⬇️
Impacted Files Coverage Δ
pandas/io/gbq.py 25% <0%> (-58.34%) ⬇️
pandas/core/frame.py 97.77% <0%> (-0.1%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4004367...cded21b. Read the comment docs.

@codecov
Copy link

codecov bot commented Sep 25, 2017

Codecov Report

Merging #17642 into master will decrease coverage by 0.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            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
Flag Coverage Δ
#multiple 88.99% <ø> (ø) ⬆️
#single 40.17% <ø> (-0.07%) ⬇️
Impacted Files Coverage Δ
pandas/io/gbq.py 25% <0%> (-58.34%) ⬇️
pandas/core/frame.py 97.77% <0%> (-0.1%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4004367...cded21b. Read the comment docs.

@jorisvandenbossche
Copy link
Member Author

This seems to be working now, so lets add some more hack and merge this. Thanks Tom for reminding me of the hack :-)

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

Successfully merging this pull request may close these issues.

None yet

3 participants