Skip to content

Commit

Permalink
FAB-7892 Add markdown capability to documentation
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
ODOWDAIBM authored and christo4ferris committed Jan 25, 2018
1 parent 88fd880 commit 39a6d56
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 1 deletion.
2 changes: 2 additions & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# SPDX-License-Identifier: Apache-2.0
python-markdown-math==0.2

alabaster==0.7.8
Expand All @@ -12,3 +13,4 @@ six==1.10.0
snowballstemmer==1.2.1
Sphinx==1.4.4
sphinx-rtd-theme==0.1.9
recommonmark==0.4.0
13 changes: 12 additions & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# -*- coding: utf-8 -*-
#
# SPDX-License-Identifier: Apache-2.0
#
# hyperledger-fabricdocs documentation build configuration file, created by
# sphinx-quickstart on Mon Feb 20 16:11:53 2017.
#
Expand Down Expand Up @@ -43,11 +45,20 @@
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# recommonmark is a python utility that allows markdown to be used within
# Sphinx projects.
# Installed version as per directive in docs/requirement.txt
from recommonmark.parser import CommonMarkParser

source_parsers = {
'.md': CommonMarkParser,
}

# 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']

# The master toctree document.
master_doc = 'index'
Expand Down

0 comments on commit 39a6d56

Please sign in to comment.