CorrelAid / pystatis

MIT License
8 stars 1 forks source link

Beautify Notebooks and Integrate into Sphinx Documentation as Tutorials #25

Open MarcoHuebner opened 9 months ago

MarcoHuebner commented 9 months ago

Our Jupyter notebooks currently lack a polished appearance, and we're missing an opportunity to showcase them effectively in our Sphinx documentation. Beautifying the notebooks by adding explaining markdown sections and seamlessly integrating them into our documentation will enhance the overall presentation and provide a more engaging experience for users and contributors.

Implementation Steps:

Notebook Beautification:

Integration into Sphinx Documentation:

sjockers commented 2 months ago

See Sphinx docs: https://docs.readthedocs.io/en/stable/guides/jupyter.html