Skip to content

Commit

Permalink
Merge pull request #69 from dib-lab/fix/doc_build
Browse files Browse the repository at this point in the history
Fix release notes generation; add recommonmark dependency
  • Loading branch information
ctb authored Apr 6, 2017
2 parents 33b2416 + 6706e30 commit 34f3459
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 2 deletions.
1 change: 1 addition & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ all:

install-dependencies:
pip install --upgrade $(DEVPKGS) || pip2 install --upgrade $(DEVPKGS)
pip install --upgrade --requirement doc/requirements.txt

install: FORCE
./setup.py build install
Expand Down
8 changes: 7 additions & 1 deletion doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@
import sys
import os

from recommonmark.parser import CommonMarkParser

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
Expand All @@ -32,8 +34,12 @@
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

source_parsers = {
'.md': CommonMarkParser,
}

# The suffix of source filenames.
source_suffix = '.rst'
source_suffix = ['.rst', '.md']

# The encoding of source files.
# source_encoding = 'utf-8-sig'
Expand Down
4 changes: 3 additions & 1 deletion doc/release-notes/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,7 @@ Contents:
.. toctree::
:maxdepth: 1

RELEASE-0.5
RELEASE-1.0
RELEASE-0.9
RELEASE-0.8
RELEASE-0.5
1 change: 1 addition & 0 deletions doc/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
recommonmark==0.4.0

0 comments on commit 34f3459

Please sign in to comment.