From 4c9fcd6d2193abe45add192663195a929a57858c Mon Sep 17 00:00:00 2001 From: Scott Shawcroft Date: Wed, 19 Oct 2016 10:22:31 -0700 Subject: [PATCH] Support markdown. --- conf.py | 5 ++++- docs/supported_ports.rst | 2 +- index.rst | 3 +++ 3 files changed, 8 insertions(+), 2 deletions(-) diff --git a/conf.py b/conf.py index 134ecf1cf3..47dc20f59f 100644 --- a/conf.py +++ b/conf.py @@ -16,6 +16,8 @@ import sys import os +from recommonmark.parser import CommonMarkParser + # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. @@ -47,7 +49,8 @@ templates_path = ['templates'] # The suffix of source filenames. source_suffix = ['.rst', '.md', '.c', '.h'] -source_parsers = {'.c': "c2rst.CStrip", '.h': "c2rst.CStrip"} +source_parsers = {'.md': CommonMarkParser, + '.c': "c2rst.CStrip", '.h': "c2rst.CStrip"} # The encoding of source files. #source_encoding = 'utf-8-sig' diff --git a/docs/supported_ports.rst b/docs/supported_ports.rst index a92be3a7c2..981a1cd3e2 100644 --- a/docs/supported_ports.rst +++ b/docs/supported_ports.rst @@ -7,4 +7,4 @@ the Atmel SAMD21 port .. toctree:: :maxdepth: 2 - atmel-samd/README.md + ../atmel-samd/README diff --git a/index.rst b/index.rst index 689854547b..adedf2b993 100644 --- a/index.rst +++ b/index.rst @@ -23,6 +23,9 @@ started guides. docs/supported_ports.rst docs/unsupported_ports.rst docs/library/index.rst + README + CONTRIBUTING + CODE_OF_CONDUCT license.rst Indices and tables