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.

Sign up for GitHub

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

Jump to bottom

Use napoleon instead of numpydoc to unpin sphinx #122

Merged
merged 1 commit into from Nov 14, 2019
Merged

Use napoleon instead of numpydoc to unpin sphinx #122

merged 1 commit into from Nov 14, 2019

Conversation

leouieda
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). Needed to update the class
autosummary template to account for missing methods summary block.

See discussion in #113

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.

@leouieda
Copy link
Member Author

This is what the update looks like:

New class docs

class-new

Current class docs

class-current

New function docs

func-new

Current function docs

func-current

santisoler
santisoler approved these changes Nov 13, 2019
View reviewed changes
Copy link
Member

@santisoler santisoler left a comment

Choose a reason for hiding this comment

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

I think it even looks better with napoleon. Glad to see you could hack this to work just fine! 🥇

@leouieda
Use napoleon instead of numpydoc to unpin sphinx
d8cfc44 
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). Needed to update the class
autosummary template to account for missing methods summary block.
@leouieda leouieda merged commit add25cf into master Nov 14, 2019
@leouieda leouieda deleted the napoleon branch November 14, 2019 08:12
@leouieda
Copy link
Member Author

👍 we should apply this to the other Fatiando projects as well

This was referenced Nov 14, 2019
Closed
Closed
Closed
Open
Merged
Merged
Merged
Open
leouieda pushed a commit to fatiando/harmonica that referenced this pull request Nov 22, 2019
@santisoler @leouieda
Use napoleon instead of numpydoc to unpin Sphinx (#129)
c814164 
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.

Fixes #128
leouieda pushed a commit to fatiando/verde that referenced this pull request Nov 22, 2019
@santisoler @leouieda
Use napoleon instead of numpydoc to unpin Sphinx (#209)
8116791 
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
leouieda added a commit to fatiando/boule that referenced this pull request Nov 29, 2019
@leouieda
Use napoleon instead of numpydoc to unpin Sphinx
b29db90 
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.
@leouieda leouieda mentioned this pull request Nov 29, 2019
Merged
5 tasks
leouieda added a commit to fatiando/boule that referenced this pull request Nov 29, 2019
@leouieda
Use napoleon instead of numpydoc to unpin Sphinx (#2)
61222be 
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.
santisoler added a commit to fatiando/rockhound that referenced this pull request Jan 24, 2020
@santisoler
Use napoleon instead of numpydoc to unpin Sphinx (#60)
d85c390 
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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@santisoler santisoler santisoler approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@leouieda @santisoler