We've been working on a Sphinx extension that lets you write Sphinx docs in 💯 markdown (incl. roles and directives). We call it "MyST Markdown" (for "Markedly Structured Text"). Give it a shot, and please give feedback! myst-parser.readthedocs.io/e…

8:53 PM · Jun 15, 2020

13
99
18
308
Replying to @choldgraf @davidism
Thank to the team for all your hard work! We really appreciate this addition to the whole Sphinx environment 💪
0
0
0
1
Replying to @choldgraf
MyST is getting more promising every day! I guess we will have to stick to reST for docstrings though? (Specially if we use napoleon and the NumPy docstring standard numpy.org/doc/stable/docs/ho…)
1
0
0
2
Replying to @choldgraf
Really liking the shift to markdown solutions here. Makes writing docs in Jupyter libraries a lot easier where we've been using this. (no offense, reST❣️)
0
0
0
3
Replying to @choldgraf
Great! Looking forward to writing docs with it. :) Is MyST Markdown a superset of CommonMark? Markdown is quite fragmented already. :/
1
0
0
0
yep, it is a superset!
0
0
0
3
Replying to @choldgraf @jakevdp
Adding to a new project right now. Thanks @choldgraf :D
0
0
0
4
Oh god yes, please I don't want to write RST anymore. I might just switch all my stuff to mdBook if no one fixes Sphinx. reStructuredText was a mistake
1
0
0
0
to be fair, Sphinx didn't invent rST, Python did (it's the core language of docutils, and Sphinx was conceived as a multi-page way to use docutils)
0
0
0
3
Replying to @choldgraf
This sounds great! A dozen years ago I co-wrote a whole book manuscript in Markdown, and while it worked well, by the end I was wishing for more rST-like features.
0
0
0
1