IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Update Markdown doc (#5913)

Browse Source 
* update Markdown doc

after relase of ecommonmark version 0.5.0
This commit is contained in:
Timotheus Kampik 2019-01-09 16:44:00 +01:00 committed by GitHub
parent 8d3be1addb
commit 14b67a0464
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/usage/markdown.rst
View File

@ -22,18 +22,14 @@ Configuration
To configure your Sphinx project for Markdown support, proceed as follows:
#. Install the Markdown parser *recommonmark* from its source on GitHub::
#. Install the Markdown parser *recommonmark*::
pip install git+https://github.com/rtfd/recommonmark
pip install --upgrade recommonmark
.. note::
The configuration as explained here requires recommonmark version
0.5.0.dev or higher, which is at the time of writing not available on
PyPI. If you want to use a released recommonmark version, follow the
instructions in the `Sphinx 1.8 documentation`__.
__ https://www.sphinx-doc.org/en/1.8/usage/markdown.html
0.5.0 or later.
#. Add *recommonmark* to the
:confval:`list of configured extensions <extensions>`::