A Sphinx extension for rendering tables written in markdown
A Sphinx extension for rendering markdown tables.
Sphinx supports markdown via Recommonmark, which does not support tables. This extension provides them.
It renders markdown tables as HTML, as defined by python-markdown
pip install sphinx-markdown-tables
Add sphinx_markdown_tables to extensions in conf.py, like so:
extensions = [
'sphinx_markdown_tables',
]
Sphinx needs to be configured to use markdown. First, you need recommonmark:
pip install recommonmark
In conf.py, configure source_parsers and source_suffix:
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',
]
For more information on Sphinx and markdown, see the Sphinx documentation.
This project is available under the GPLv3 license. For other licensing arrangements contact Ryan Fox.