Skip to main content

Yet another markdown processor for Sphinx

Project description

sphinxcontrib-markdown

Yet another markdown processor for Sphinx

https://travis-ci.org/tk0miya/sphinxcontrib-markdown.svg?branch=master https://coveralls.io/repos/tk0miya/sphinxcontrib-markdown/badge.png?branch=master https://codeclimate.com/github/tk0miya/sphinxcontrib-markdown/badges/gpa.svg

Setting

Install

$ pip install sphinxcontrib-markdown

Configure Sphinx

Add .md to source_suffix and parser class to source_parsers in your conf.py:

source_suffix = ['.rst', '.md']
source_parsers = {
    '.md': 'sphinxcontrib.markdown.MarkdownParser'
}

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

sphinxcontrib-markdown-0.1.0.tar.gz (4.9 kB view details)

Uploaded Source

Built Distribution

sphinxcontrib_markdown-0.1.0-py2.py3-none-any.whl (5.8 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file sphinxcontrib-markdown-0.1.0.tar.gz.

File metadata

File hashes

Hashes for sphinxcontrib-markdown-0.1.0.tar.gz
Algorithm Hash digest
SHA256 8205c996b81b3ced4e4cd1db480e32a900385573df8a592185a0edb19894908f
MD5 09598f2a0ffc50bb46bfa76f5d1303ea
BLAKE2b-256 d24258359f7b598256dd640d2221467bc439d04b88c607814b92c6899e1290f2

See more details on using hashes here.

File details

Details for the file sphinxcontrib_markdown-0.1.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for sphinxcontrib_markdown-0.1.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 c6c7cb7802fc9e0283df994d63df3985e9e6abfc1e9de6c3172d1298855cd4bf
MD5 0cc6556b60b31d807d6fec41d0201a1d
BLAKE2b-256 7e1734a3d7c8e3afe9273447cbd305440c9514c37757c46a7d3a26ff0a5381f6

See more details on using hashes here.

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