Skip to content

Commit

Permalink
Add markdown support
Browse files Browse the repository at this point in the history
  • Loading branch information
JiaweiZhuang committed Jan 18, 2018
1 parent 1e12781 commit 718032b
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 2 deletions.
10 changes: 8 additions & 2 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,8 @@
# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = '.rst'
source_suffix = ['.rst', '.md']
# source_suffix = '.rst'

# The master toctree document.
master_doc = 'index'
Expand Down Expand Up @@ -173,3 +173,9 @@ def setup(app):
author, 'cloud_GC', 'One line description of project.',
'Miscellaneous'),
]

# -- Markdown support through recommonmark ------

source_parsers = {
'.md': 'recommonmark.parser.CommonMarkParser',
}
1 change: 1 addition & 0 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,4 @@ Contents

motivation
tutorial
test_markdown
16 changes: 16 additions & 0 deletions doc/test_markdown.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Markdown Header

Foo in **Markdown**, which means we can do **inline *italics* like this**

## Markdown Lower Header

More second-level content.

[A link](http://rtfd.org)

You can even do:

```bash

Code blocks
```

0 comments on commit 718032b

Please sign in to comment.