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

Improve documentation #143

Open
kallewesterling opened this issue Jun 14, 2024 · 0 comments
Open

Improve documentation #143

kallewesterling opened this issue Jun 14, 2024 · 0 comments

Comments

@kallewesterling
Copy link

  • Set up industry standard package for documentation, e.g. Sphinx
  • Set up appropriate file structure for Sphinx, and move notebooks into the documentation (as worked examples)
  • Add instructions on how to contribute to the codebase
  • Add instructions to the README on how to build the documentation for the codebase (for folks who want to contribute to the documentation, e.g. "How do I add another worked example to the repository?")
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

No branches or pull requests

1 participant