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

chore: Support notebooks in docs #954

Open
zilto opened this issue Jun 13, 2024 · 0 comments
Open

chore: Support notebooks in docs #954

zilto opened this issue Jun 13, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@zilto
Copy link
Collaborator

zilto commented Jun 13, 2024

The most straightforward avenue for creating a "Hamilton cookbook" would be to support rendering notebooks as pages via a Sphinx plugin. This would make it easier for people to browse examples from the documentation. Instead of supporting interactivity directly from the docs, notebooks can include a link to launch the page in a Google Colab if appropriate.

ref: https://docs.readthedocs.io/en/stable/guides/jupyter.html

@zilto zilto added documentation Improvements or additions to documentation enhancement New feature or request labels Jun 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant