From a952ed414cb1f166324deea7495f1f0119a1c16d Mon Sep 17 00:00:00 2001 From: Baptiste Bauvin <baptiste.bauvin@lis-lab.fr> Date: Fri, 1 May 2020 10:11:04 -0400 Subject: [PATCH] Readme in doc --- README.rst | 6 ++++-- docs/source/index.rst | 5 +++-- 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index 82435bfe..ddbdfd46 100644 --- a/README.rst +++ b/README.rst @@ -1,4 +1,5 @@ -.. image:: https://img.shields.io/badge/License-GPL%20v3-blue.svg)](http://www.gnu.org/licenses/gpl-3.0 +.. image:: https://img.shields.io/badge/License-GPL%20v3-blue.svg + :target: http://www.gnu.org/licenses/gpl-3.0 :alt: License: GPL v3 .. |pipeline| image:: https://gitlab.lis-lab.fr/baptiste.bauvin/summit/badges/master/pipeline.svg @@ -122,7 +123,8 @@ Once you have formatted your dataset, to run SuMMIT on it you need to modify the It is however highly recommended to follow the documentation's `tutorials <http://baptiste.bauvin.pages.lis-lab.fr/summit/tutorials/index.html>`_ to learn the use of each parameter. -## Author +Authors +------- * **Baptiste BAUVIN** * **Dominique BENIELLI** diff --git a/docs/source/index.rst b/docs/source/index.rst index dfa5e0db..1151c1cf 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -16,9 +16,10 @@ This documentation consists in a short read me, with instructions to install and tutorials/index api - readme_link -.. examples + +.. include:: readme_link.rst + Indices and tables -- GitLab