Skip to main content

A Sphinx extension for rendering checkboxes written in markdown

Project description

sphinx-markdown-checkbox

Inspired by sphinx-markdown-tables, this project renders markdown checkboxes as HTML using pycmarkgfm, because Recommonmark does not support markdown checkboxes.

Installation

pip install sphinx-markdown-checkbox

Usage

If you have installed recommonmark

Add sphinx_markdown_checkbox to extensions in conf.py, like so:

extensions = [
    'sphinx_markdown_checkbox',
]

Otherwise

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_checkbox to extensions, like so:

extensions = [
    'sphinx_markdown_checkbox',
]

For more information on Sphinx and markdown, see the Sphinx documentation.

License

This project is available under the GPLv3 license.

Project details


Download files

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

Source Distribution

sphinx-markdown-checkbox-0.1.0.tar.gz (15.2 kB view hashes)

Uploaded Source

Built Distribution

sphinx_markdown_checkbox-0.1.0-py3-none-any.whl (26.7 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page