Replace Sphinx napoleon for numpydoc #450
Merged
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
Replace the builtin Sphinx plugin `napoleon` for `numpydoc`. This solves the issue of attributes with trailing underscore not rendering properly in docs. Add `numpydoc` as requirement for building the docs and add it to the Sphinx configuration file. Remove `napoleon` from Sphinx configuration. Remove the "Methods Summary" section in the Sphinx class template since `numpydoc` builds its own list of all methods. Related to fatiando/community#149
santisoler
commented
Apr 25, 2024
Edit the class template to show a list of attributes with extended descriptions.
|
Thanks @santisoler! |
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.
Replace the built-in Sphinx plugin
napoleonfornumpydoc. This solves the issue of attributes with trailing underscore not rendering properly in docs. Addnumpydocas requirement for building the docs and add it to the Sphinx configuration file. Removenapoleonfrom Sphinx configuration. Remove the "Methods Summary" section in the Sphinx class template sincenumpydocbuilds its own list of all methods.Relevant issues/PRs:
Related to fatiando/community#149