Skip to content
Snippets Groups Projects
Commit 5e70ca3c authored by Joseph Weston's avatar Joseph Weston
Browse files

add markdown parser to documentation building

Also replace index.rst with a verbatim copy of the readme (for now).
parent 289c09a9
No related branches found
No related tags found
No related merge requests found
This commit is part of merge request !120. Comments created here will be created in the context of that merge request.
...@@ -47,14 +47,18 @@ extensions = [ ...@@ -47,14 +47,18 @@ extensions = [
'sphinx.ext.napoleon', 'sphinx.ext.napoleon',
] ]
source_parsers = {
'.md': 'recommonmark.parser.CommonMarkParser',
}
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates'] templates_path = ['_templates']
# The suffix(es) of source filenames. # The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string: # You can specify multiple suffix as a list of string:
# #
# source_suffix = ['.rst', '.md'] source_suffix = ['.rst', '.md']
source_suffix = '.rst' #source_suffix = '.rst'
# The master toctree document. # The master toctree document.
master_doc = 'index' master_doc = 'index'
......
../../README.md
\ No newline at end of file
.. adaptive documentation master file, created by
sphinx-quickstart on Mon Aug 20 16:51:02 2018.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to adaptive's documentation!
====================================
.. toctree::
:maxdepth: 2
:caption: Contents:
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment