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 documentation #61

Open
FlorisCalkoen opened this issue Feb 12, 2024 · 0 comments
Open

Add documentation #61

FlorisCalkoen opened this issue Feb 12, 2024 · 0 comments

Comments

@FlorisCalkoen
Copy link
Owner

Both for the package and cookbook we still have to write docs. I would suggest to document any function following Google docstring format, which we then assemble into a Sphinx documentation (e.g., pydata layout) and publish on a static page. For the package we can fully automate the process. For the cookbook (examples of how to build/maintain notebooks for this course) we might have to do some research. Also it would be useful if we could attach some figures that illustrate the overall architecture.

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