README still refers to reST
Most common issues The most issues are in restructured text:
Title underline are too short; they should be at least as long as the title
Missing new line, after list
links are broken, OK Link text <link URL>_
Replaced back quote by another type of quote: 'Link text <link URL>"_ Missing space before < link Linktext<link URL>_ Extra space after > link Linktext <link URL> _ Extra space after back tick Linktext <link URL> _
Closing italic or bold text is not done, or a space is added before or after
OK My bold text
Not OK ** My broken bold text **
Markdown syntax is used in rst files, they are not compatible.
Directive are translated, https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html