Sphinx usage markdown

See also

• http://www.sphinx-doc.org/en/master/usage/markdown.html

• https://daringfireball.net/

Contents

• Sphinx usage markdown

  • Markdown

  • Practical sphinx

    • markdown

Markdown

Markdown is a lightweight markup language with a simplistic plain text formatting syntax. It exists in many syntactically different flavors.

To support Markdown-based documentation, Sphinx can use recommonmark.

recommonmark is a Docutils bridge to CommonMark-py, a Python package for parsing the CommonMark Markdown flavor.

Practical sphinx

See also

https://speakerdeck.com/willingc/practical-sphinx

markdown

# For conversion from markdown to html
import recommonmark.parser

# Add a source file parser for markdown
source_parsers = {
        '.md': 'recommonmark.parser.CommonMarkParser'
}

# Add type of source files
source_suffix = ['.rst', '.md']