sphinx-markdown-tables

What it is and what it does

sphinx-markdown-tables is a Sphinx extension that fills a gap in Recommonmark's markdown support by adding table rendering. Recommonmark allows Sphinx to parse markdown source files, but does not natively handle markdown table syntax; this extension intercepts those tables and renders them as HTML using the python-markdown table specification.

The extension is installed as a single line in Sphinx's conf.py and requires only the markdown package as a runtime dependency. It is designed for documentation projects that mix reStructuredText and markdown sources and need tables in their markdown files to appear in the final HTML output.

Use it for:

• Add markdown table support to a Sphinx project that uses Recommonmark for markdown parsing.
• Render markdown-formatted tables in HTML documentation without converting them to reStructuredText.
• Maintain markdown source files with tables in a mixed-format Sphinx documentation build.
• Generate HTML tables from markdown syntax in Sphinx-based project documentation.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Adds markdown table support to Sphinx documentation by extending Recommonmark's markdown parser to render tables as HTML.

No. The package is abandoned (last commit 2022-07-29, no activity for 1477 days) and classifiers indicate testing only up to Python 3.6. While it has no known vulnerabilities and low install friction, the lack of maintenance means it may break with newer Sphinx or Python versions. Consider it only if you are locked to older, stable versions of Sphinx and Recommonmark that you do not plan to upgrade.

Install

sphinx-markdown-tables on PyPI

pip install sphinx-markdown-tables

uv add sphinx-markdown-tables

poetry add sphinx-markdown-tables

Installing sphinx-markdown-tables

Before you install

Low friction install with a single runtime dependency (markdown). However, the package is abandoned—last release was 2022-07-29 and no commits since then. Use only if your Sphinx and Recommonmark versions remain stable.

License in practice

Licensed under GPLv3 (copyleft). Any derivative work or distribution must also be GPLv3; proprietary projects should verify compatibility or seek alternative licensing from the original author.

Quickstart

pip install sphinx-markdown-tables

# In conf.py:
extensions = [
    'sphinx_markdown_tables',
]

Requires Sphinx and Recommonmark to be configured for markdown parsing; Sphinx must have source_parsers and source_suffix set up for .md files.

Verify before relying

• Whether the extension works with current Sphinx versions (last tested 2022-07-29)
• Compatibility with modern Python versions beyond 3.6 (classifiers list only up to 3.6)

Package facts

Evidence: sphinx_markdown_tables-0.0.17-py3-none-any.whl

Keywords: sphinx, markdown, tables

Tags

More Build Tools packages