-
Notifications
You must be signed in to change notification settings - Fork 17
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
Replace sphinx napoleon for numpydoc #195
Merged
Commits on Apr 25, 2024
-
Configuration menu - View commit details
-
Copy full SHA for 89ba04b - Browse repository at this point
Copy the full SHA 89ba04bView commit details -
Update Sphinx templates for classes
Remove the list of methods and attributes from the template since numpydoc builds its own lists for them.
Configuration menu - View commit details
-
Copy full SHA for 1144552 - Browse repository at this point
Copy the full SHA 1144552View commit details -
Include caution admonitions in Notes section
Put the admonitions in the Notes section to make numpydoc to render it properly.
Configuration menu - View commit details
-
Copy full SHA for f045fe6 - Browse repository at this point
Copy the full SHA f045fe6View commit details -
Configuration menu - View commit details
-
Copy full SHA for dde55be - Browse repository at this point
Copy the full SHA dde55beView commit details
Commits on May 10, 2024
-
Restore attributes to the class template
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.
Configuration menu - View commit details
-
Copy full SHA for 62b0e7c - Browse repository at this point
Copy the full SHA 62b0e7cView commit details -
Show attributes like the parameters section
Configure numpydoc to show the list of attributes as the parameters section.
Configuration menu - View commit details
-
Copy full SHA for f41c13c - Browse repository at this point
Copy the full SHA f41c13cView commit details
Commits on Jun 7, 2024
-
Configuration menu - View commit details
-
Copy full SHA for 2d04861 - Browse repository at this point
Copy the full SHA 2d04861View commit details
Commits on Oct 8, 2024
-
Configuration menu - View commit details
-
Copy full SHA for a9e726d - Browse repository at this point
Copy the full SHA a9e726dView commit details -
Configuration menu - View commit details
-
Copy full SHA for e812967 - Browse repository at this point
Copy the full SHA e812967View commit details
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.