Skip to content
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

Use napoleon instead of numpydoc to unpin Sphinx #209

Merged
merged 2 commits into from
Nov 22, 2019
Merged

Use napoleon instead of numpydoc to unpin Sphinx #209

merged 2 commits into from
Nov 22, 2019

Conversation

santisoler
Copy link
Member

@santisoler santisoler commented Nov 14, 2019

The combination of latest sphinx (2.2.0), numpydoc, and sphinx_rtd_theme
causes a mangled rendering of the parameter list. We were pinning sphinx
to 1.8.5, which is getting old and causing dependency problems.
Replacing numpydoc with sphinx.ext.napoleon fixes the problem (though
generates slightly different output). Modify autosummary class in order
to generate a Methods Summary. Update Sphinx configuration: change
values of napoleon configuration to compile Returns and Attributes with
the same style as the Parameters list. The changes applied were based on
fatiando/pooch#122 and fatiando/harmonica#129.

Fixes #208

Reminders

  • Run make format and make check to make sure the code follows the style guide.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Add new public functions/methods/classes to doc/api/index.rst and verde/__init__.py.
  • Write detailed docstrings for all functions/classes/methods.
  • If adding new functionality, add an example to the docstring, gallery, and/or tutorials.

Replace numpydoc for sphinx.ext.napoleon and unpin old Sphinx (1.8.5).
Modify autosummary class in order to generate a Methods Summary. Update
Sphinx configuration: change values of napoleon configuration to compile
Returns and Attributes with the same style as the Parameters list.
@leouieda leouieda changed the title WIP Use napoleon instead of numpydoc to unpin Sphinx Use napoleon instead of numpydoc to unpin Sphinx Nov 22, 2019
Copy link
Member

@leouieda leouieda left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 thanks, @santisoler!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Replace numpydoc for napoleon to unpin Sphinx
2 participants