Markdown Tables in Sphinx
Sphinx is a really useful tool, but one shortcoming is its markdown support. Specifically, it uses the recommonmark specification, which does not support tables. I wrote a Sphinx extension to render tables authored in markdown.
It can be installed via pip install sphinx-markdown-tables
.
If you don't already have Sphinx configured to parse markdown, run
pip install recommonmark
, and edit conf.py
to tell Sphinx to parse your
markdown files:
source_parsers = {
'.md': 'recommonmark.parser.CommonMarkParser',
}
source_suffix = ['.rst', '.md']
Once Sphinx is configured appropriately, add sphinx-markdown-tables to extensions, like so:
extensions = [
'sphinx-markdown-tables',
]
You can find the source on github here.