3 ms·
In late 2018, GitHub-flavoured Markdown (GFM) has basically won, and is in tools used every day. reStructuredText has always had a learning curve, but is even m
by guitarbill 8y ago
In late 2018, GitHub-flavoured Markdown (GFM) has basically won, and is in tools used every day. reStructuredText has always had a learning curve, but is even more painful if you're used to using Markdown (`foo` in MD vs ``foo`` in reST).
I do use reStructuredText/Sphinx for Python, but it's a chore onboarding new developers, to the point where I may not bother in future. Getting developers to write docs is the most important - badly formatted Markdown is still better than no docs. Lower barrier to entry wins. Eric does understand this very well via Read the Docs/Write the Docs (which are awesome), but reStructuredText's weirdness will always be an issue.