Hacker News new | ask | show | jobs
by carso 933 days ago
You can use markdown by adding the md suffix to your conf.py and myst_parser [1] to your sphinx extensions.

They are starting to work towards full sphinx functionality in myst markdown, too.

[1] https://myst-parser.readthedocs.io/en/latest/intro.html [1] https://executablebooks.org/en/latest/blog/2023/new-project-...

1 comments

I can't recommend this enough! It's such a quality of life improvement to get the powerful dynamic documentation features of rST and Sphinx (and its many extensions), but in the more pleasant and familiar syntax of Markdown. I use MyST + Sphinx for all my project docs now.

This podcast episode is worth a listen for anyone interested in these tools and where they're headed: https://talkpython.fm/episodes/show/354/sphinx-myst-and-pyth...