.rst or .md for documentation? about python-template HOT 4 CLOSED

Ah, difficult question. I agree that MarkDown is easier to use, on the other hand my experience with Cerise is that ReStructuredText works better for writing larger, more complex bodies of documentation.

So MD is easier to start with, but RST scales better. I'm tempted to say "If MarkDown suffices, then you don't have enough documentation yet."...

from python-template.

Yes, I agree. Specifically for Python projects RST is the preferred format.

from python-template.

So maby then it is more consistent to have a README.rst instead of README.md

from python-template.

I agree, for Kernel Tuner I also switched to RST after a while because it integrates better with the rest of the documentation.

from python-template.