Thursday, 21 July 2016

Documenting with Sphinx and Markdown

Several nice recipes in the web:

 * http://dorianpula.ca/2015/09/02/markdown-documentation-with-sphinx/

 * http://searchvoidstar.tumblr.com/post/125486358368/making-pdfs-from-markdown-on-readthedocsorg-using.

 * http://docs.readthedocs.io/en/latest/getting_started.html#in-markdown

But, keep in mind that several files like indexes must be always .rst files.

Markdown will be parsed from .md files.

Summarizing, the basic steps are installing remarkdown and enabling it on Sphinx conf.py



pip install remarkdown #or recommonmark!?!?

# The suffix of source filenames.
from recommonmark.parser import CommonMarkParser

# The suffix of source filenames.
source_suffix = [’.rst’, ’.md’]

source_parsers = {
   ’.md’: CommonMarkParser,
}

No comments:

Post a Comment