Replace sphinx napoleon for numpydoc #195
Open
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
Remove the list of methods and attributes from the template since numpydoc builds its own lists for them.
Put the admonitions in the Notes section to make numpydoc to render it properly.
|
I'm noticing that the attributes section only show a shorten description, without the mathematical definitions. I think we should fix that before merging this PR. |
Include the attributes to the class template so we can still show detailed descriptions for them, including math and their units. The attribute list that numpydoc generate has links to the corresponding description of the attributes.
|
I restored the attributes list in the class template, so we can have both the attribute list generated by numpydoc (with just a single line description) and the extended descriptions below. The attributes in the list generated by numpydoc link to their corresponding extended description, making the navigation process easy. I think I like this @leouieda, let me know what do you think. |
Configure numpydoc to show the list of attributes as the parameters section.
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.
Add
numpydocto requirements for building the docs. Addnumpydocto Sphinx configuration file. Update Sphinx template for classes. Move admonitions inEllipsoidandSphereclasses to the Notes section sonumpydoccan render them properly.Relevant issues/PRs:
Related to fatiando/community#149