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 example notebooks to docs html pages #154

Open
CalMacCQ opened this issue Aug 30, 2024 · 0 comments
Open

Add example notebooks to docs html pages #154

CalMacCQ opened this issue Aug 30, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@CalMacCQ
Copy link
Contributor

CalMacCQ commented Aug 30, 2024

Would be nice to add the example notebooks to the docs pages.

Should be easy with using the same MyST-NB library that we use to display the example notebooks here.

Note that executing the example notebooks requires GPU access (something we don't have available in C.I. atm). If we wanted to show the cell outputs we could execute them locally before commiting. Even showing the code without outputs would probably be fine.

Needs #153 finished first

@CalMacCQ CalMacCQ added the documentation Improvements or additions to documentation label Aug 30, 2024
@CalMacCQ CalMacCQ self-assigned this Aug 30, 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
Projects
None yet
Development

No branches or pull requests

1 participant