Skip to main content

A Sphinx extension for rendering tables written in markdown

Project description

Build Status Code Coverage

Note:

This is a fork of sphinx-markdown-tables package that works with newer versions of the markdown package.

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 dhubbard-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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for dhubbard-sphinx-markdown-tables, version 0.1.140866
Filename, size File type Python version Upload date Hashes
Filename, size dhubbard_sphinx_markdown_tables-0.1.140866-py3-none-any.whl (15.8 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size dhubbard-sphinx-markdown-tables-0.1.140866.tar.gz (15.1 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page