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

#5216 add note regarding recommonmark version

Browse Source
This commit is contained in:
Timotheus Kampik
2018-12-23 17:27:54 +01:00
parent 20c9489828
commit 9583290653
1 changed files with 9 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
doc/usage/markdown.rst
View File

@@ -26,6 +26,15 @@ To configure your Sphinx project for Markdown support, proceed as follows:
pip install git+https://github.com/rtfd/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
#. Add *recommonmark* to the
:confval:`list of configured extensions <extensions>`::