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


Release history Release notifications

Download files

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

Files for sphinxcontrib-markdown, version 0.1.0
Filename, size File type Python version Upload date Hashes
Filename, size sphinxcontrib_markdown-0.1.0-py2.py3-none-any.whl (5.8 kB) File type Wheel Python version 2.7 Upload date Hashes View hashes
Filename, size sphinxcontrib-markdown-0.1.0.tar.gz (4.9 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page