A Sphinx extension for rendering tables written in markdown
Project description
sphinx-markdown-tables
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
Installation
pip install sphinx-markdown-tables
Usage
Quick version
Add sphinx_markdown_tables
to extensions
in conf.py
, like so:
extensions = [
'sphinx_markdown_tables',
]
Longer version
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.
License
This project is available under the GPLv3 license. For other licensing arrangements contact Ryan Fox.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file sphinx-markdown-tables-0.0.16.tar.gz
.
File metadata
- Download URL: sphinx-markdown-tables-0.0.16.tar.gz
- Upload date:
- Size: 15.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.8.10
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9c0f47acf590273fd41f77d793329546552e30f7b07922d727cb027e989b6409 |
|
MD5 | ca34f1c593a049b28fad606077947a6c |
|
BLAKE2b-256 | b6858335cca399f75e54a1d54745d3d2376d970c93d97c39c7f53edd6eb8625e |
File details
Details for the file sphinx_markdown_tables-0.0.16-py3-none-any.whl
.
File metadata
- Download URL: sphinx_markdown_tables-0.0.16-py3-none-any.whl
- Upload date:
- Size: 28.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.8.10
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9c43ea74f5cdbedad1057f30e2e68bcdd502493c1dd8345adc20a3a96d09686b |
|
MD5 | 1686bac416d94c159e188e639337734d |
|
BLAKE2b-256 | b69b3f42edce9f2191bfbcb00d53dc04a179e2302e07e70caad4becf036d0f48 |