A Sphinx extension for rendering tables written in markdown
Project description
# sphinx-markdown-tables
A [Sphinx](http://www.sphinx-doc.org/en/master/) extension for rendering markdown tables.
Sphinx supports markdown via [Recommonmark,](https://github.com/rtfd/recommonmark) which does not support tables. This
extension provides them.
It renders markdown tables as HTML, as defined by [python-markdown](https://python-markdown.github.io/)
## 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.](http://www.sphinx-doc.org/en/master/usage/markdown.html)
A [Sphinx](http://www.sphinx-doc.org/en/master/) extension for rendering markdown tables.
Sphinx supports markdown via [Recommonmark,](https://github.com/rtfd/recommonmark) which does not support tables. This
extension provides them.
It renders markdown tables as HTML, as defined by [python-markdown](https://python-markdown.github.io/)
## 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.](http://www.sphinx-doc.org/en/master/usage/markdown.html)
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
Close
Hashes for sphinx-markdown-tables-0.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9a2fea5dca612294cee484258c158c2726b4ee4504a49abc2afc82a15554316c |
|
MD5 | 9737f0a5f84e931031d989cdc6108684 |
|
BLAKE2b-256 | eb74d089a8733e751ee981c3237ddd8b095d238b2152e31e85057a69535b5410 |
Close
Hashes for sphinx_markdown_tables-0.0.1-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3594acdfe4d668ebe235d2df4eacb05ee01998b73c7a544d31e7e6014ded67c1 |
|
MD5 | 5e68c8bc5ac28a988f4417bd62d9aa6a |
|
BLAKE2b-256 | 0206590cd2eea316143e3feff31e694ae2779f6067d9e051fca33a6f40fbb90d |