Subscribe to DSC Newsletter

Lightweight but effective way of documenting a group of Jupyter Notebooks

My app Qubiter has a folder full of Jupyter notebooks (27 of them, in fact). Opening a notebook takes a short while, which is slightly annoying. I wanted to give Qubiter users the ability to peek inside all the notebooks at once, without having to open all of them. Qubiter’s new SUMMARY.ipynb notebook allows the user to do just that.

SUMMARY.ipynb scans the directory in which it lives to find all Jupyter notebooks (other than itself) in that directory. It then prints for every notebook it finds (1) a hyperlink to the notebook, and (2) the first cell (which is always markdown) of the notebook. This way you can read a nice, automatically generated summary of all the notebooks without having to open all of them. If you find a notebook that you want to explore further, you can simply click on its link to open it.

Here is the code that I use. I posted it on StackOveflow

https://stackoverflow.com/questions/56829884/how-to-execute-cell-1-...

And here is Qubiter's notebook using the code:

https://nbviewer.jupyter.org/github/artiste-qb-net/qubiter/blob/mas...

Views: 288

Tags: Jupyter, notebook

Comment

You need to be a member of Data Science Central to add comments!

Join Data Science Central

© 2019   Data Science Central ®   Powered by

Badges  |  Report an Issue  |  Privacy Policy  |  Terms of Service