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

Documentation Gallery #14

Open

erwanp opened this issue Jan 5, 2021 · 1 comment

Member

erwanp commented Jan 5, 2021 •

edited

Loading

Show examples under a nice HTML Gallery ?

An .html could be generated and shown on 🌱 RADIS-lab start.
Users would start with a page similar to this: https://sphinx-gallery.github.io/stable/auto_examples/index.html#gallery-of-examples

Ressources :

https://sphinx-gallery.github.io/stable/index.html

(linked to the same need for the main RADIS repo radis/radis#136)

Member Author

erwanp commented Jan 5, 2021 •

edited

Loading

💡 I think this is what we need : https://github.com/Chilipp/sphinx-nbexamples

However, library is hard to understand and apply to an existing project.

start by cloning them and move from there
run library locally. Fixed exception: No such kernel named bash Chilipp/sphinx-nbexamples#17
change the examples to our own : https://github.com/radis/radis-lab/tree/main/examples
generate the docs locally on Docker build
make it a homepage on Docker run

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment