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

Setup automatic documentation #26

Open
KieranLitschel opened this issue Jan 25, 2021 · 0 comments
Open

Setup automatic documentation #26

KieranLitschel opened this issue Jan 25, 2021 · 0 comments
Assignees
@KieranLitschel

Comments

@KieranLitschel
Copy link
Owner

We are using numpy style docstrings. These can be used to automatically generate documentation in Sphinx using the Napoleon extension. We should set this up.
@KieranLitschel KieranLitschel self-assigned this Jan 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@KieranLitschel KieranLitschel

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@KieranLitschel