Thanks @areusch . To provide a bit of background, our document was initially 
built with Sphinx markdown parser(recommonmark) that allowed a mix of rst and 
md. We also made several contributions to recommonmark to structify certain 
markdown elements.

As we start to write more structured components like cross reference and other 
layouts, we found out that it is easier to keep a consistent to use 
reStructuredText instead. The markdown parser was OK for certain components but 
still do not allow us to obtain the best control of the structure component. 
MySt likely will have a similar problems we faced before. 

Eventually we found that in order to write the best structured doc seems rst is 
needed and more consistent across the docstring and tutorials(note that we will 
likely need to use rst for tutorials due to limit of the Sphinx gallery), and 
some requirement on learning of reStructuredText is needed anyway(although 
likely be more strange to use), even in the markdown setting. Finally, seems 
most of the popular packages such as pytorch, sklearn, numpy follows the 
approach of using rSt for docs while in some cases still have a discuss forum, 
where discussions are more unstructured and markdown is preferred.  As a result 
we turned everything to rst and removed the dep on Sphinx markdown support.





---
[Visit 
Topic](https://discuss.tvm.apache.org/t/docs-discuss-convert-restructuredtext-docs-to-markdown/10264/2)
 to respond.

You are receiving this because you enabled mailing list mode.

To unsubscribe from these emails, [click 
here](https://discuss.tvm.apache.org/email/unsubscribe/6e51054874ecf6cbded231d2069a6773341b6ca2524df4370d465ef8e11e8dd4).

Reply via email to