diff --git a/doc/markdown.rst b/doc/markdown.rst index 04ae29466..75a35b9d0 100644 --- a/doc/markdown.rst +++ b/doc/markdown.rst @@ -8,21 +8,22 @@ Markdown support `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 `CommonMark-py `__, a -Python package for parsing the `CommonMark `__ flavor. In addition, Sphinx uses -`recommonmark `__, a Docutils bridge to CommonMark. +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. Configuration ------------- -To configure your Sphinx project for markdown support, proceed as follows: +To configure your Sphinx project for Markdown support, proceed as follows: -#. Install CommonMark version **0.5.4** and recommonmark: +#. Install recommonmark: :: - pip install commonmark==0.5.4 recommonmark + pip install recommonmark #. Add the Markdown parser to the ``source_parsers`` configuration variable in your Sphinx configuration file: