search

SNEWS2 / snewpy

A Python package for working with supernova neutrinos
https://snewpy.readthedocs.io
BSD 3-Clause "New" or "Revised" License
26 stars 19 forks source link

Include notebooks in documentation #185

Open JostMigenda opened 2 years ago

JostMigenda commented 2 years ago

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.

Sheshuk commented 5 months ago

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.