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

Generate index notebook #57

Open
hodgestar opened this issue Dec 1, 2022 · 3 comments
Open

Generate index notebook #57

hodgestar opened this issue Dec 1, 2022 · 3 comments

Comments

@hodgestar
Copy link
Contributor

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
Copy link

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

@hodgestar
Copy link
Contributor Author

@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
Copy link

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants