search

qutip / qutip-tutorials

QuTiP Tutorials
BSD 3-Clause "New" or "Revised" License
32 stars 34 forks source link

Generate index notebook #57

Open hodgestar opened 1 year ago

hodgestar commented 1 year ago

We currently generate an index HTML page, but it would be great to also generate an index notebook. This would allow us to provide an nbviewer, Binder or try-qutip link to the index notebook, which would be a nice way for users to explore the full set of tutorials.

devyloper commented 1 year ago

Hi @hodgestar! Is this still open? If yes, may I create the notebook?

hodgestar commented 1 year ago

@devyloper It is!

Note that we'd like an autogenerated index, similar to the one generated for the website, but as a notebook (in Markdown format) instead of an HTML page. You might still be able to use the Jinja templating engine.

devyloper commented 1 year ago

nbformat can be used to generate the index notebook file similar to the website. Converting the already generated html files for both versions to md files and then appending them to respective index ipynb files that will be generated.