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.
1 maintainer
Release files for sphinx-markdown-checkbox 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sphinx-markdown-checkbox-0.1.0.tar.gz | 15.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinx_markdown_checkbox-0.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 41.9 kB
Release files / sphinx-markdown-checkbox-0.1.0.tar.gz
| Download URL | sphinx-markdown-checkbox-0.1.0.tar.gz |
|---|---|
| Size | 15.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f53353a449228358c8b6831317178dd4f83f22f4a951c06eed447dad07c359b1
|
|
BLAKE2b-256 checksum How to use checksums |
cc362e1fd51fcdf750e5a83531d950a348d32298ee8101b41786a148c2b73a3a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.6.8
|
Release files / sphinx_markdown_checkbox-0.1.0-py3-none-any.whl
| Download URL | sphinx_markdown_checkbox-0.1.0-py3-none-any.whl |
|---|---|
| Size | 26.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b0ee15e206027dd7d5ce8da3c37ec3fd88697e32dca68c308ecb13dc12d8c5b9
|
|
BLAKE2b-256 checksum How to use checksums |
921ec2e9f2a70a23a0342ad90346bbfabdd16abaaf65d7e49222bb1ba76aff55
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.6.8
|
