Skip to content

Commit 6bd6721

Browse files
WasabiFanddemidov
authored andcommitted
Enable using markdown for Sphinx docs (#401)
1 parent ef23296 commit 6bd6721

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

docs/conf.py

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,10 @@
2525
if on_rtd:
2626
import pip
2727
pip.main(['install', 'sphinx_bootstrap_theme'])
28+
pip.main(['install', 'recommonmark'])
2829

2930
import sphinx_bootstrap_theme
31+
from recommonmark.parser import CommonMarkParser
3032

3133
# If extensions (or modules to document with autodoc) are in another directory,
3234
# add these directories to sys.path here. If the directory is relative to the
@@ -49,10 +51,14 @@
4951
# Add any paths that contain templates here, relative to this directory.
5052
templates_path = ['_templates']
5153

54+
source_parsers = {
55+
'.md': CommonMarkParser,
56+
}
57+
5258
# The suffix(es) of source filenames.
5359
# You can specify multiple suffix as a list of string:
5460
# source_suffix = ['.rst', '.md']
55-
source_suffix = '.rst'
61+
source_suffix = ['.rst', '.md']
5662

5763
# The encoding of source files.
5864
#source_encoding = 'utf-8-sig'

0 commit comments

Comments
 (0)