Sphinx recommonmark
From wikinotes
Render from markdown/html instead of ReStructuredText.
You may also like sphinx sphinx-markdown-tables.
NOTE:
Sphinx myst may be more powerful
Documentation
official docs https://recommonmark.readthedocs.io/en/latest/index.html sphinx markdown docs https://www.sphinx-doc.org/en/master/usage/markdown.html github https://github.com/readthedocs/recommonmark
Configuration
# ${PACKAGE}/requirements.txt sphinx recommonmark
# ${PACKAGE}/source/conf.py extensions = [ 'recommonmark', 'sphinx.ext.autosectionlabel', ] autosectionlabel_prefix_document = True # allow use both .rst and .md source_suffix = ['.rst', '.md']
Usage
Literally, replace
.rst
with.md
.Sample file.
# some title my `awesome` text yo. A [external link](https://google.com). an [internal](pages/internal.html) link. <table> <tr> <th>foo</th> <th>bar</th> </tr> <tr> <td>foo</td> <td>bar</td> </tr> </table>