Consider using MyST for Sphinx-compatible Markdown documentation

czbiohub-sf / orpheum

Orpheum (Previously called and published under sencha) is a Python package for directly translating RNA-seq reads into coding protein sequence.

MIT License

18 stars 4 forks source link

Consider using MyST for Sphinx-compatible Markdown documentation #79

Open olgabot opened 4 years ago

olgabot commented 4 years ago

Learned about this from: https://github.com/dib-lab/sourmash/pull/1021

From MyST documentation:

MyST allows you to write Sphinx documentation entirely in markdown. MyST markdown provides a markdown equivalent of the reStructuredText syntax, meaning that you can do anything in MyST that you can do with reStructuredText. It is an attempt to have the best of both worlds: the flexibility and extensibility of Sphinx with the simplicity and readability of Markdown.

choldgraf commented 4 years ago

Hey all! I'm one of the folks that works on myst, happy to answer questions if it's helpful!