Skip to content

Commit 39a6d56

Browse files
ODOWDAIBMchristo4ferris
authored andcommitted
FAB-7892 Add markdown capability to documentation
add license headers to changed files Change-Id: I1e7bdf4b655c35392e80ef88ca93a7dd4b0befe0 Signed-off-by: Anthony O'Dowd <a_o-dowd@uk.ibm.com> Signed-off-by: Christopher Ferris <chrisfer@us.ibm.com>
1 parent 88fd880 commit 39a6d56

File tree

2 files changed

+14
-1
lines changed

2 files changed

+14
-1
lines changed

docs/requirements.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
# SPDX-License-Identifier: Apache-2.0
12
python-markdown-math==0.2
23

34
alabaster==0.7.8
@@ -12,3 +13,4 @@ six==1.10.0
1213
snowballstemmer==1.2.1
1314
Sphinx==1.4.4
1415
sphinx-rtd-theme==0.1.9
16+
recommonmark==0.4.0

docs/source/conf.py

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# -*- coding: utf-8 -*-
22
#
3+
# SPDX-License-Identifier: Apache-2.0
4+
#
35
# hyperledger-fabricdocs documentation build configuration file, created by
46
# sphinx-quickstart on Mon Feb 20 16:11:53 2017.
57
#
@@ -43,11 +45,20 @@
4345
# Add any paths that contain templates here, relative to this directory.
4446
templates_path = ['_templates']
4547

48+
# recommonmark is a python utility that allows markdown to be used within
49+
# Sphinx projects.
50+
# Installed version as per directive in docs/requirement.txt
51+
from recommonmark.parser import CommonMarkParser
52+
53+
source_parsers = {
54+
'.md': CommonMarkParser,
55+
}
56+
4657
# The suffix(es) of source filenames.
4758
# You can specify multiple suffix as a list of string:
4859
#
4960
# source_suffix = ['.rst', '.md']
50-
source_suffix = '.rst'
61+
source_suffix = ['.rst', '.md']
5162

5263
# The master toctree document.
5364
master_doc = 'index'

0 commit comments

Comments
 (0)