Skip to content

Commit c517953

Browse files
jbwestonbasnijholt
authored andcommitted
add markdown parser to documentation building
Also replace index.rst with a verbatim copy of the readme (for now).
1 parent 77a12a1 commit c517953

3 files changed

Lines changed: 7 additions & 22 deletions

File tree

docs/source/conf.py

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,14 +47,18 @@
4747
'sphinx.ext.napoleon',
4848
]
4949

50+
source_parsers = {
51+
'.md': 'recommonmark.parser.CommonMarkParser',
52+
}
53+
5054
# Add any paths that contain templates here, relative to this directory.
5155
templates_path = ['_templates']
5256

5357
# The suffix(es) of source filenames.
5458
# You can specify multiple suffix as a list of string:
5559
#
56-
# source_suffix = ['.rst', '.md']
57-
source_suffix = '.rst'
60+
source_suffix = ['.rst', '.md']
61+
#source_suffix = '.rst'
5862

5963
# The master toctree document.
6064
master_doc = 'index'

docs/source/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../README.md

docs/source/index.rst

Lines changed: 0 additions & 20 deletions
This file was deleted.

0 commit comments

Comments
 (0)