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 hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page