Clean up autosummary usage #54457
Merged
Clean up autosummary usage #54457
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
In my local builds this PR does not appear to increase the number of warnings at all, suggesting that the changes are safe. |
Closed
3 tasks
vyasr
force-pushed
the
feat/cleanup_docs
branch
from
efefa47
to
19ec625
Compare
|
I pushed an update to add accessor attributes to the API reference |
vyasr
force-pushed
the
feat/cleanup_docs
branch
from
2570167
to
c4c2277
Compare
vyasr
force-pushed
the
feat/cleanup_docs
branch
from
c4c2277
to
33f78a0
Compare
mroeschke
approved these changes
Aug 17, 2023
|
Awesome, thanks @vyasr |
mroeschke
pushed a commit
to mroeschke/pandas
that referenced
this pull request
Aug 18, 2023
* Disable numpydoc and use autosummary instead * Add toctree for accessors
1 task
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR stops numpydoc from producing the summary tables for a class's methods and attributes, preferring to instead rely on autosummary. This approach allows using a class.rst template that isn't relying on hacks to get autosummary to still generate stub pages. In a follow-up PR we can look into removing more of those hacks throughout the code base, this PR is just scoped to resolve the issues with the main class.rst template.
doc/source/whatsnew/vX.X.X.rstfile if fixing a bug or adding a new feature.