sphinx-markdown-tables

0.0.17last stable release 2 years ago
Complexity Score
Low
Open Issues
11
Dependent Projects
114
Weekly Downloadsglobal
27,468

License

  • GPL-3.0

    Downloads

    Readme

    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.

    Dependencies

    No runtime dependency information found for this package.

    CVE IssuesActive
    0
    Scorecards Score
    3.20
    Test Coverage
    No Data
    Follows Semver
    Yes
    Github Stars
    59
    Dependenciestotal
    1
    DependenciesOutdated
    0
    DependenciesDeprecated
    0
    Threat Modelling
    No
    Repo Audits
    No

    Learn how to distribute sphinx-markdown-tables in your own private PyPI registry

    pip install sphinx-markdown-tables
    Processing...
    Done

    16 Releases

    PyPI on Cloudsmith

    Getting started with PyPI on Cloudsmith is fast and easy.