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)
## License
This project is available under the GPLv3 license. For other licensing arrangements contact
[Ryan Fox.](https://foxrow.com)
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)
## License
This project is available under the GPLv3 license. For other licensing arrangements contact
[Ryan Fox.](https://foxrow.com)
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 Distributions
No source distribution files available for this release.See tutorial on generating distribution archives.
Built Distribution
File details
Details for the file sphinx_markdown_tables-0.0.4-py3-none-any.whl
.
File metadata
- Download URL: sphinx_markdown_tables-0.0.4-py3-none-any.whl
- Upload date:
- Size: 4.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 56f2458b0bbb27bd59b4615d601ef365ed48fb9b230dd38dd3e34920bc40e2b4 |
|
MD5 | fd6f65d94af4d7f6f14f903bf147d1f3 |
|
BLAKE2b-256 | 84db19e471526232c141504c20fbd655a00ab1f7e1ea0256587bf31399994d77 |