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

Add docs examples #160

Open
nsryan2 opened this issue Feb 23, 2024 · 0 comments
Open

Add docs examples #160

nsryan2 opened this issue Feb 23, 2024 · 0 comments

Comments

@nsryan2
Copy link
Member

nsryan2 commented Feb 23, 2024

The docs from #158 do not include examples. There is a package called nbsphinx that will allow the docs to use a jupyter notebook, so examples can be created in notebooks (hint hint, the projects probably have notebooks you can draw from). The examples can also be added to docstrings for the functions.

This issue can be closed when there are examples for each of the scripts.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant