Replace the built-in 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.
leouieda
commented
6 months ago
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