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
Render nicely in the API docs.
Can be very clear when hovering over a method in IDE's that support it, like VSCode:
I've found [2] to be very valuable when doing development. However RestructuredText-like elements like :param X: and :returns: aren't rendered:
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 π).
Currently the automatically generated parts of the documentation are still in RestructuredText:
aiida.sphinxext
itemsIt 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
Can be very clear when hovering over a method in IDE's that support it, like VSCode:
I've found [2] to be very valuable when doing development. However RestructuredText-like elements like
:param X:
and:returns:
aren't rendered: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 π).