Open santisoler opened 7 months ago
Probably we don't need numpydoc
in Pooch. Numpy is not one of its dependencies and I think we are not facing any issue right now using napoloen in its docs. I think it's safe to remove Pooch from the list.
Agreed 👍🏾
Description:
In https://github.com/fatiando/harmonica/issues/490 I noticed that some attributes that have a trailing underscore (like
coefs_
in equivalent sources) are not properly shown in the API reference of the docs.The issue is coming from the Sphinx plugin we are currently using across the projects to render the docstrings of functions and classes as rst: napoleon. Moreover, it renames
Attributes
toVariables
, which is not ideal.One way to solve this issue is to move from napoleon to numpydoc. Since we are already making use of the numpydoc style in our docstrings, this replacement seems natural.
I was already experimenting with this, and noticed that the classes would get a duplicated Methods list section. @leouieda suggested that the duplicated one might be coming from the template we have set up for classes. If numpydoc is generating the methods list, we should get rid of it in the template.
Apply to:
Further instructions:
Related to fatiando/community#XX
We want your help!
We know that maintenance tasks are very demanding, so we don't expect a single person to tackle this issue by themselves. Any help is very welcomed, so please comment below that you want to take care of the changes on any repository and we will assign it to you.