Browse code
add markdown parser to documentation building
Also replace index.rst with a verbatim copy of the readme (for now).
Joseph Weston authored on 09/10/2018 13:58:00
• Bas Nijholt committed on 16/10/2018 18:12:39
Showing 3 changed files
| ... | ... |
@@ -47,14 +47,18 @@ extensions = [ |
| 47 | 47 |
'sphinx.ext.napoleon', |
| 48 | 48 |
] |
| 49 | 49 |
|
| 50 |
+source_parsers = {
|
|
| 51 |
+ '.md': 'recommonmark.parser.CommonMarkParser', |
|
| 52 |
+} |
|
| 53 |
+ |
|
| 50 | 54 |
# Add any paths that contain templates here, relative to this directory. |
| 51 | 55 |
templates_path = ['_templates'] |
| 52 | 56 |
|
| 53 | 57 |
# The suffix(es) of source filenames. |
| 54 | 58 |
# You can specify multiple suffix as a list of string: |
| 55 | 59 |
# |
| 56 |
-# source_suffix = ['.rst', '.md'] |
|
| 57 |
-source_suffix = '.rst' |
|
| 60 |
+source_suffix = ['.rst', '.md'] |
|
| 61 |
+#source_suffix = '.rst' |
|
| 58 | 62 |
|
| 59 | 63 |
# The master toctree document. |
| 60 | 64 |
master_doc = 'index' |
| 1 | 3 |
deleted file mode 100644 |
| ... | ... |
@@ -1,20 +0,0 @@ |
| 1 |
-.. adaptive documentation master file, created by |
|
| 2 |
- sphinx-quickstart on Mon Aug 20 16:51:02 2018. |
|
| 3 |
- You can adapt this file completely to your liking, but it should at least |
|
| 4 |
- contain the root `toctree` directive. |
|
| 5 |
- |
|
| 6 |
-Welcome to adaptive's documentation! |
|
| 7 |
-==================================== |
|
| 8 |
- |
|
| 9 |
-.. toctree:: |
|
| 10 |
- :maxdepth: 2 |
|
| 11 |
- :caption: Contents: |
|
| 12 |
- |
|
| 13 |
- |
|
| 14 |
- |
|
| 15 |
-Indices and tables |
|
| 16 |
-================== |
|
| 17 |
- |
|
| 18 |
-* :ref:`genindex` |
|
| 19 |
-* :ref:`modindex` |
|
| 20 |
-* :ref:`search` |