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

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

Uploaded Python 2 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