Commit f4c0d22a authored by Lukas Riedel's avatar Lukas Riedel

include README into Sphinx docs via recommonmark

parent 3e651327
......@@ -16,6 +16,9 @@
import sys
import os
import shlex
import recommonmark
from recommonmark.parser import CommonMarkParser
from recommonmark.transform import AutoStructify
# 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
......@@ -30,10 +33,6 @@ rst_prolog = """
.. |branch| replace:: @DEPLOY_SPHINX_GITBRANCH@
"""
def setup(app): # pass this along
app.add_config_value('deploy_mode', '', 'env')
sys.path.append('@DUNE_SPHINX_EXT_PATH@')
#python_modules = '@DORIE_PYTHON_MODULES@'
......@@ -68,10 +67,15 @@ else:
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# specify custom source parsers
source_parsers = {
'.md': 'recommonmark.parser.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 encoding of source files.
#source_encoding = 'utf-8-sig'
......@@ -325,3 +329,11 @@ texinfo_documents = [
breathe_projects = { "dorie": "@CMAKE_CURRENT_BINARY_DIR@/doxygen/xml" }
breathe_default_project = "dorie"
# -- Pass special options to build setup ---------------------------------
def setup(app):
app.add_config_value('deploy_mode', '', 'env')
app.add_config_value('recommonmark_config', {
}, True)
app.add_transform(AutoStructify)
\ No newline at end of file
......@@ -4,6 +4,16 @@ Installation
.. contents::
.. _readme:
ReadMe File
-----------
.. toctree::
:maxdepth: 1
README
Prerequisites
#############
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment