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

ENH: Napoleon #180

Merged
merged 11 commits into from
Feb 4, 2020
Merged

ENH: Napoleon #180

merged 11 commits into from
Feb 4, 2020

Conversation

zssherman
Copy link
Collaborator

A nice version of numpy docs, removes the need for numpy doc extension as napoleon is built in with sphinx. This will fix the colon issue, and with the docs, I will add more commits to this pull request for the colon spacing. Overall cleaner docs. Down the road can invest in autosummary templates for modules, classes, and base so there would no longer be a need for rsts for all modules and submodules, just an index.rst

Napoleon overall is cleaner and its a sphinx extension, so removed need
for numpydoc.
@zssherman zssherman requested a review from AdamTheisen February 3, 2020 22:59
@AdamTheisen
Copy link
Collaborator

Thanks for all this work @zssherman! Pinging @kenkehoe as well so that he's aware of the document updates.

@AdamTheisen AdamTheisen merged commit 69981aa into ARM-DOE:master Feb 4, 2020
@kenkehoe
Copy link
Contributor

kenkehoe commented Feb 4, 2020

Awesome thanks!

@zssherman zssherman deleted the napoleon branch August 3, 2022 15:04
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.

3 participants