8000 Support markdown. · boneskull/circuitpython@c16d4e1 · GitHub
[go: up one dir, main page]

Skip to content

Commit c16d4e1

Browse files
committed
Support markdown.
1 parent 4e0d10f commit c16d4e1

File tree

3 files changed

+8
-2
lines changed

3 files changed

+8
-2
lines changed

conf.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@
1616
import sys
1717
import os
1818

19+
from recommonmark.parser import CommonMarkParser
20+
1921
# If extensions (or modules to document with autodoc) are in another directory,
2022
# add these directories to sys.path here. If the directory is relative to the
2123
# documentation root, use os.path.abspath to make it absolute, like shown here.
@@ -47,7 +49,8 @@
4749
# The suffix of source filenames.
4850
source_suffix = ['.rst', '.md', '.c', '.h']
4951

50-
source_parsers = {'.c': "c2rst.CStrip", '.h': "c2rst.CStrip"}
52+
source_parsers = {'.md': CommonMarkParser,
53+
'.c': "c2rst.CStrip", '.h': "c2rst.CStrip"}
5154

5255
# The encoding of source files.
5356
#source_encoding = 'utf-8-sig'

docs/supported_ports.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ the Atmel SAMD21 port
77
.. toctree::
88
:maxdepth: 2
99

10-
atmel-samd/README.md
10+
../atmel-samd/README

index.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,9 @@ started guides.
2323
docs/supported_ports.rst
2424
docs/unsupported_ports.rst
2525
docs/library/index.rst
26+
README
27+
CONTRIBUTING
28+
CODE_OF_CONDUCT
2629
license.rst
2730

2831
Indices and tables

0 commit comments

Comments
 (0)
0