Skip to content
This repository has been archived by the owner on Jun 30, 2022. It is now read-only.

Use napoleon instead of numpydoc to unpin Sphinx #60

Merged
merged 4 commits into from Jan 24, 2020
Merged

Conversation

santisoler
Copy link
Member

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 #59

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.
  • Write detailed docstrings for all functions/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.
@santisoler santisoler changed the title WIP Use napoleon instead of numpydoc to unpin Sphinx Use napoleon instead of numpydoc to unpin Sphinx Dec 9, 2019
@santisoler santisoler merged commit d85c390 into master Jan 24, 2020
@santisoler santisoler deleted the napoleon branch January 24, 2020 17:44
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Replace numpydoc for napoleon to unpin Sphinx
1 participant