aiidateam / aiida-quantumespresso

The official AiiDA plugin for Quantum ESPRESSO
https://aiida-quantumespresso.readthedocs.io
Other
53 stars 78 forks source link

📚Docs: Switch to using MyST Markdown #924

Closed mbercx closed 1 year ago

mbercx commented 1 year ago

We should convert our documentation into MyST Markdown:

https://myst-parser.readthedocs.io/en/latest/index.html

Using RST is a bit tricky since you always have to relearn the syntax, while Markdown is used everywhere. We can also just copy-paste text from our (sometimes quite extensive) GitHub of Slack discussions without having to adapt the syntax.

This also would allow us to start integrating Jupyter notebooks using MyST-NB and jupytext, making it also possible to write documentation that can be tested.