diff --git a/docs/source/conf.py b/docs/source/conf.py index cd07ffa3d3a347b60187c9d939d26c0a1cb70825..b4cd11ff49f949362c50f874e51ba124fbd1ea00 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 29f81276096193448f4d1649074300fb136af2b4..783ed09b6fc3329740568766d2985c89dab1b153 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 ce359fbab953f3f651b6da770b75859dcbadb3ec..a5998328eb8b0d325008df7d4496b9333c4f167d 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 ===============================================