Skip to content
Snippets Groups Projects
Commit f015b5f8 authored by Baptiste Bauvin's avatar Baptiste Bauvin
Browse files

Worked on some doc

parent 5b71ef98
No related branches found
No related tags found
No related merge requests found
# -*- coding: utf-8 -*- # -*- coding: utf-8 -*-
from recommonmark.parser import CommonMarkParser
from recommonmark.transform import AutoStructify
# #
# MultiviewPlatform documentation build configuration file, created by # MultiviewPlatform documentation build configuration file, created by
# sphinx-quickstart on Mon Jan 29 17:13:09 2018. # sphinx-quickstart on Mon Jan 29 17:13:09 2018.
...@@ -50,8 +52,12 @@ templates_path = ['_templates'] ...@@ -50,8 +52,12 @@ templates_path = ['_templates']
# The suffix(es) of source filenames. # The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string: # You can specify multiple suffix as a list of string:
# #
# source_suffix = ['.rst', '.md'] source_suffix = ['.rst', '.md']
source_suffix = '.rst' # source_suffix = '.rst'
source_parsers = {
'.md': CommonMarkParser,
}
# The master toctree document. # The master toctree document.
master_doc = 'index' master_doc = 'index'
...@@ -169,3 +175,10 @@ texinfo_documents = [ ...@@ -169,3 +175,10 @@ texinfo_documents = [
# Example configuration for intersphinx: refer to the Python standard library. # Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'https://docs.python.org/': None} intersphinx_mapping = {'https://docs.python.org/': None}
def setup(app):
app.add_config_value('recommonmark_config', {
'url_resolver': lambda url: github_doc_root + url,
'auto_toc_tree_section': 'Contents',
}, True)
app.add_transform(AutoStructify)
\ No newline at end of file
...@@ -14,7 +14,9 @@ The main advantage of the platform is that it allows to add and remove a classif ...@@ -14,7 +14,9 @@ The main advantage of the platform is that it allows to add and remove a classif
:maxdepth: 3 :maxdepth: 3
:caption: Contents: :caption: Contents:
api readme
.. api
.. examples .. examples
......
Read me
=======
.. include:: ../../README.md
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment