Documentation Gallery

[erwanp]

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)

[erwanp]

💡 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