From 3de0733e70dbb07fac67afa013bd853b61ccf678 Mon Sep 17 00:00:00 2001 From: Martin Quinson Date: Tue, 31 Jul 2018 11:05:14 +0200 Subject: [PATCH] doc: fix broken inline markup --- docs/source/installation.rst | 2 ++ docs/source/main_concepts.rst | 44 +++++++++++++++++------------------ 2 files changed, 24 insertions(+), 22 deletions(-) diff --git a/docs/source/installation.rst b/docs/source/installation.rst index 60af9b9359..06fe3291a6 100644 --- a/docs/source/installation.rst +++ b/docs/source/installation.rst @@ -1,5 +1,7 @@ .. Copyright 2005-2018 +.. _install: + Installing SimGrid ================== diff --git a/docs/source/main_concepts.rst b/docs/source/main_concepts.rst index 2c894c560b..051dddd81d 100644 --- a/docs/source/main_concepts.rst +++ b/docs/source/main_concepts.rst @@ -218,43 +218,43 @@ SimGrid Success Stories SimGrid was cited in over 1,500 scientific papers (according to Google Scholar). Among them -over 200 -publications (written by about 300 individuals) use SimGrid as a -scientific instrument to conduct their experimental evaluation. These +`over 200 publications `_ +(written by about 300 individuals) use SimGrid as a scientific +instrument to conduct their experimental evaluation. These numbers do not count the articles contributing to SimGrid. This instrument was used in many research communities, such as -High-Performance Computing, -Cloud Computing, -Workflow Scheduling, -Big Data and -MapReduce, -Data Grid, -Volunteer Computing, -Peer-to-Peer Computing, -Network Architecture, -Fog Computing, or -Batch Scheduling -(more info). +`High-Performance Computing `_, +`Cloud Computing `_, +`Workflow Scheduling `_, +`Big Data `_ and +`MapReduce `_, +`Data Grid `_, +`Volunteer Computing `_, +`Peer-to-Peer Computing `_, +`Network Architecture `_, +`Fog Computing `_, or +`Batch Scheduling `_ +`(more info) `_. If your platform description is accurate enough (see -here or -there), +`here `_ or +`there `_), SimGrid can provide high-quality performance predictions. For example, we determined the speedup achieved by the Tibidabo Arm-based cluster before its construction -(paper). In this case, +(`paper `_). In this case, some differences between the prediction and the real timings were due to misconfiguration or other problems with the real platforms. To some extent, SimGrid could even be used to debug the real platform :) SimGrid is also used to debug, improve and tune several large applications. -BigDFT (a massively parallel code +`BigDFT `_ (a massively parallel code computing the electronic structure of chemical elements developped by -the CEA), StarPU (a +the CEA), `StarPU `_ (a Unified Runtime System for Heterogeneous Multicore Architectures developped by Inria Bordeaux) and -TomP2P (a high performance +`TomP2P `_ (a high performance key-value pair storage library developped at University of Zurich). Some of these applications enjoy large user communities themselves. @@ -262,6 +262,6 @@ Where to proceed next? ---------------------- Now that you know about the basic concepts of SimGrid, you can give it -a try. If it's not done yet, first @ref install "install it". Then, +a try. If it's not done yet, first :ref:`install it `. Then, proceed to the section on @ref application "describing the application" that you want to study. -- 2.20.1