From 920010bfb12d25c58f520356a3b09351f7790398 Mon Sep 17 00:00:00 2001
From: Baptiste Bauvin <baptiste.bauvin@lis-lab.fr>
Date: Wed, 1 Apr 2020 10:36:25 -0400
Subject: [PATCH] link and prolog
---
docs/source/conf.py | 14 ++++++++++++++
docs/source/tutorials/example0.rst | 2 +-
docs/source/tutorials/example1.rst | 6 ------
3 files changed, 15 insertions(+), 7 deletions(-)
diff --git a/docs/source/conf.py b/docs/source/conf.py
index cd07ffa3..b4cd11ff 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -41,6 +41,7 @@ add_module_names = False
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = ['sphinx.ext.autodoc',
+ 'sphinx.ext.extlinks'
# 'sphinx.ext.doctest',
# 'sphinx.ext.intersphinx',
# 'sphinx.ext.todo',
@@ -183,3 +184,16 @@ intersphinx_mapping = {'https://docs.python.org/': None}
# 'auto_toc_tree_section': 'Contents',
# }, True)
# app.add_transform(AutoStructify)
+rst_prolog = """
+.. role:: python(code)
+ :language: python
+
+.. role :: yaml(code)
+ :language: yaml
+
+... |platf| replace:: replacement SuMMIT
+"""
+
+
+extlinks = {'base_source': ('https://gitlab.lis-lab.fr/baptiste.bauvin/multiview-machine-learning-omis/-/tree/master/', "base_source"),
+ 'base_doc': ('http://baptiste.bauvin.pages.lis-lab.fr/multiview-machine-learning-omis/', 'base_doc')}
diff --git a/docs/source/tutorials/example0.rst b/docs/source/tutorials/example0.rst
index 29f81276..783ed09b 100644
--- a/docs/source/tutorials/example0.rst
+++ b/docs/source/tutorials/example0.rst
@@ -16,4 +16,4 @@ To run SuMMIT on digits, one has to run
>>> from multiview_platform.execute import execute
>>> execute("example 0")
-This will start a benchmark with this config file located in ``
\ No newline at end of file
+This will start a benchmark with the config file located in `plif <base_source/multiview_platform/examples/config_files>`_
\ No newline at end of file
diff --git a/docs/source/tutorials/example1.rst b/docs/source/tutorials/example1.rst
index ce359fba..a5998328 100644
--- a/docs/source/tutorials/example1.rst
+++ b/docs/source/tutorials/example1.rst
@@ -1,9 +1,3 @@
-.. role:: python(code)
- :language: python
-
-.. role :: yaml(code)
- :language: yaml
-
===============================================
Example 1 : First steps with SuMMIT
===============================================
--
GitLab