DOC: Fix non-standard napoleon
custom section mapping
#206
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.
Fix non-standard
napoleon
custom section mapping:Inputs
andOutputs
toparams_style
andreturns_style
, respectively, instead of mapping them toParameters
.Mandatory Inputs
andOptional Inputs
toparams_style
, instead of mapping them toParameters
.numpydoc
extension and set thenumpy_doc_show_class_members
andautodoc_typehints
flags so that theAttributes
docstrings are shown.Attributes
section to theAttributes
string in order to show that value instead ofVariables
in the corresponding documentation section.Documentation:
https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html#confval-napoleon_custom_sections https://stackoverflow.com/questions/72220924/sphinx-how-to-show-attributes-as-in-scipy