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

Replace Sphinx napoleon for numpydoc #84

Merged
merged 2 commits into from
May 21, 2024
Merged

Replace Sphinx napoleon for numpydoc #84

merged 2 commits into from
May 21, 2024

Conversation

santisoler
Copy link
Member

@santisoler santisoler commented May 10, 2024

Replace the builtin Sphinx plugin napoleon for generating the summaries of functions and classes for the numpydoc plugin. Include numpydoc as a requirement for building the docs and in environment.yml. Configure Sphinx to use numpydoc when building the docs.

Relevant issues/PRs:

Related to fatiando/community#149

Include numpydoc as a requirement for building the docs and in
`environment.yml`. Configure Sphinx to use numpydoc when building the
docs.
@santisoler santisoler changed the title Replace napoleon for numpydoc Replace Sphinx napoleon for numpydoc May 10, 2024
@santisoler santisoler merged commit 46dcd81 into main May 21, 2024
15 checks passed
@santisoler santisoler deleted the numpydoc branch May 21, 2024 19:48
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.

1 participant