From f015b5f8066c2c060b4645e3a6e8317f06fd0c0a Mon Sep 17 00:00:00 2001
From: Baptiste Bauvin <baptiste.bauvin.1@ulaval.ca>
Date: Wed, 7 Feb 2018 14:15:23 -0500
Subject: [PATCH] Worked on some doc
---
docs/source/conf.py | 17 +++++++++++++++--
docs/source/index.rst | 4 +++-
docs/source/readme.rst | 3 +++
3 files changed, 21 insertions(+), 3 deletions(-)
create mode 100644 docs/source/readme.rst
diff --git a/docs/source/conf.py b/docs/source/conf.py
index 87552b05..89899abc 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -1,4 +1,6 @@
# -*- coding: utf-8 -*-
+from recommonmark.parser import CommonMarkParser
+from recommonmark.transform import AutoStructify
#
# MultiviewPlatform documentation build configuration file, created by
# sphinx-quickstart on Mon Jan 29 17:13:09 2018.
@@ -50,8 +52,12 @@ templates_path = ['_templates']
# 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']
+# source_suffix = '.rst'
+
+source_parsers = {
+ '.md': CommonMarkParser,
+}
# The master toctree document.
master_doc = 'index'
@@ -169,3 +175,10 @@ texinfo_documents = [
# Example configuration for intersphinx: refer to the Python standard library.
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
diff --git a/docs/source/index.rst b/docs/source/index.rst
index d4da5fc0..55ceb2cb 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -14,7 +14,9 @@ The main advantage of the platform is that it allows to add and remove a classif
:maxdepth: 3
:caption: Contents:
- api
+ readme
+.. api
+
.. examples
diff --git a/docs/source/readme.rst b/docs/source/readme.rst
new file mode 100644
index 00000000..8ba7870d
--- /dev/null
+++ b/docs/source/readme.rst
@@ -0,0 +1,3 @@
+Read me
+=======
+ .. include:: ../../README.md
\ No newline at end of file
--
GitLab