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.

Sign up for GitHub

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

Jump to bottom

Include notebooks in documentation #185

Open
JostMigenda opened this issue Feb 9, 2022 · 1 comment
Open

Include notebooks in documentation #185

JostMigenda opened this issue Feb 9, 2022 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@JostMigenda
Copy link
Member

As discussed elsewhere, it’s possible to include Jupyter notebooks in Sphinx documentation.
I haven’t tried this out yet, but it looks like a great way to make all of our excellent notebooks (both on specific models and with general usage examples) more visible.
@JostMigenda JostMigenda added the documentation Improvements or additions to documentation label Feb 9, 2022
@JostMigenda JostMigenda mentioned this issue Apr 8, 2024
Merged
@Sheshuk
Copy link
Contributor

Sheshuk commented Apr 11, 2024

This is a good idea.
Apart from the documentation, they will be a good addition to our integration testing - checking that they work without errors before merging a branch will force us to keep them up to date.

@JostMigenda JostMigenda mentioned this issue Apr 22, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@Sheshuk @JostMigenda