aiidateam / aiida-quantumespresso

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

πŸ“š DOCS: Convert autodoc elements to Markdown #932

Open mbercx opened 1 year ago

mbercx commented 1 year ago

Currently the automatically generated parts of the documentation are still in RestructuredText:

It would be good to switch to an entirely Markdown formatted documentation for consistency. I think it would also be possible to have docstrings in Markdown, which again would make it much easier to write docstrings that

  1. Render nicely in the API docs.
  2. Can be very clear when hovering over a method in IDE's that support it, like VSCode:

    Screenshot 2023-05-10 at 07 28 26

I've found [2] to be very valuable when doing development. However RestructuredText-like elements like :param X: and :returns: aren't rendered:

Screenshot 2023-05-10 at 07 31 56

Maybe there is an extension for this, but if we can just do everything in Markdown, I think our lives would become easier (no more thinking if we need single or double backticks somewhere πŸ˜‰).