From 16ed988954d8c7dd104e6f680b80118f22b360c0 Mon Sep 17 00:00:00 2001
From: Erwan Jahier <erwan.jahier@univ-grenoble-alpes.fr>
Date: Mon, 2 Dec 2019 14:40:12 +0100
Subject: [PATCH] Doc: fix the doc generation
---
guides/users/Makefile | 1 +
guides/users/README.md | 146 ++++++++++++++++++++--------------------
guides/users/README.org | 2 +-
3 files changed, 75 insertions(+), 74 deletions(-)
diff --git a/guides/users/Makefile b/guides/users/Makefile
index 4c0d321e..7dacea09 100644
--- a/guides/users/Makefile
+++ b/guides/users/Makefile
@@ -2,6 +2,7 @@
all:README.html algo
algo:
+ cd ../..; make odoc
cp -rf ../../_build/default/_doc/_html .
%.html:%.org
diff --git a/guides/users/README.md b/guides/users/README.md
index b3f83c95..f3e68ca3 100644
--- a/guides/users/README.md
+++ b/guides/users/README.md
@@ -1,56 +1,56 @@
-- [TL;DR](#org0b7d40f)
-- [Topology](#org1419282)
-- [Algorithms](#org70394d8)
-- [Examples](#org3b76953)
-- [Batch mode](#orga4022cf)
- - [Running batch simulations with Built-in demons](#orgdb69516)
- - [Running batch simulations with manual demons](#org95fb51a)
- - [Running batch simulations with `lurette`](#orgfcad4fc)
- - [Viewing Results](#org8048ac1)
- - [The `sasa` CLI](#orge3e533c)
-- [Interactive mode](#orgc7e936e)
- - [Example: use `rdbg` from the `test/alea-coloring/` directory](#orga377025)
- - [The exemples of test directory](#org4e448a1)
- - [Running interactive sessions with `rdbg`](#orge05191d)
- - [Getting `rdbg` on-line help](#orgadf3937)
- - [Useful Modules](#org9c358cf)
-- [Install](#org612a386)
- - [Via opam 2 (prefered method)](#org6342735)
- - [Via docker](#org9c12c34)
- - [From source](#org9d18133)
-- [More](#org17190c0)
-- [FAQ](#org0149295)
- - [Is there a FAQ?](#org87dd6d1)
+- [TL;DR](#org1b29c61)
+- [Topology](#org7ac1440)
+- [Algorithms](#org15e10c7)
+- [Examples](#org6a40149)
+- [Batch mode](#orga9bce8f)
+ - [Running batch simulations with Built-in demons](#org4866456)
+ - [Running batch simulations with manual demons](#orgf3df31d)
+ - [Running batch simulations with `lurette`](#org9d9ef24)
+ - [Viewing Results](#org477c3d3)
+ - [The `sasa` CLI](#org262a057)
+- [Interactive mode](#orgc6d5408)
+ - [Example: use `rdbg` from the `test/alea-coloring/` directory](#org9b78bb5)
+ - [The exemples of test directory](#org2006456)
+ - [Running interactive sessions with `rdbg`](#org964d57c)
+ - [Getting `rdbg` on-line help](#orgf6c6506)
+ - [Useful Modules](#org911eaed)
+- [Install](#orgf00383a)
+ - [Via opam 2 (prefered method)](#orgd5a02ba)
+ - [Via docker](#org4a9d80f)
+ - [From source](#org0ce02ed)
+- [More](#orgc3319a2)
+- [FAQ](#org76c8af0)
+ - [Is there a FAQ?](#org3a27f5b)
# Table of Contents
-1. [TL;DR](#org0b7d40f)
-2. [Topology](#org1419282)
-3. [Algorithms](#org70394d8)
-4. [Examples](#org3b76953)
-5. [Batch mode](#orga4022cf)
- 1. [Running batch simulations with Built-in demons](#orgdb69516)
- 2. [Running batch simulations with manual demons](#org95fb51a)
- 3. [Running batch simulations with `lurette`](#orgfcad4fc)
- 4. [Viewing Results](#org8048ac1)
- 5. [The `sasa` CLI](#orge3e533c)
-6. [Interactive mode](#orgc7e936e)
- 1. [Example: use `rdbg` from the `test/alea-coloring/` directory](#orga377025)
- 2. [The exemples of test directory](#org4e448a1)
- 3. [Running interactive sessions with `rdbg`](#orge05191d)
- 4. [Getting `rdbg` on-line help](#orgadf3937)
- 5. [Useful Modules](#org9c358cf)
-7. [Install](#org612a386)
- 1. [Via opam 2 (prefered method)](#org6342735)
- 2. [Via docker](#org9c12c34)
- 3. [From source](#org9d18133)
-8. [More](#org17190c0)
-9. [FAQ](#org0149295)
- 1. [Is there a FAQ?](#org87dd6d1)
-
-
-<a id="org0b7d40f"></a>
+1. [TL;DR](#org1b29c61)
+2. [Topology](#org7ac1440)
+3. [Algorithms](#org15e10c7)
+4. [Examples](#org6a40149)
+5. [Batch mode](#orga9bce8f)
+ 1. [Running batch simulations with Built-in demons](#org4866456)
+ 2. [Running batch simulations with manual demons](#orgf3df31d)
+ 3. [Running batch simulations with `lurette`](#org9d9ef24)
+ 4. [Viewing Results](#org477c3d3)
+ 5. [The `sasa` CLI](#org262a057)
+6. [Interactive mode](#orgc6d5408)
+ 1. [Example: use `rdbg` from the `test/alea-coloring/` directory](#org9b78bb5)
+ 2. [The exemples of test directory](#org2006456)
+ 3. [Running interactive sessions with `rdbg`](#org964d57c)
+ 4. [Getting `rdbg` on-line help](#orgf6c6506)
+ 5. [Useful Modules](#org911eaed)
+7. [Install](#orgf00383a)
+ 1. [Via opam 2 (prefered method)](#orgd5a02ba)
+ 2. [Via docker](#org4a9d80f)
+ 3. [From source](#org0ce02ed)
+8. [More](#orgc3319a2)
+9. [FAQ](#org76c8af0)
+ 1. [Is there a FAQ?](#org3a27f5b)
+
+
+<a id="org1b29c61"></a>
# TL;DR
@@ -76,7 +76,7 @@ sasa ring.dot
The source code is available at <https://gricad-gitlab.univ-grenoble-alpes.fr/verimag/synchrone/sasa>
-<a id="org1419282"></a>
+<a id="org7ac1440"></a>
# Topology
@@ -139,7 +139,7 @@ Such parameters can be retreived in Algorithms using the `Algo.get_graph_attribu
nb: a `Algo.diameter: unit -> int` function is provided, but it can be expensive to use.
-<a id="org70394d8"></a>
+<a id="org15e10c7"></a>
# Algorithms
@@ -151,7 +151,7 @@ The following has been generated from [algo.mli](https://gricad-gitlab.univ-gren
</div>
-<a id="org3b76953"></a>
+<a id="org6a40149"></a>
# Examples
@@ -179,12 +179,12 @@ The `test` directory also contains sub-directories which gathers programs shared
- `test/*/my-rdbg-tuning.ml`: includes `test/my-rdbg-tuning.ml` and defines commands specific to the example of the directory. Indeed, `rdbg`, once launched, first tries to read the content of the file name `my-rdbg-tuning.ml` (it it exists).
-<a id="orga4022cf"></a>
+<a id="orga9bce8f"></a>
# Batch mode
-<a id="orgdb69516"></a>
+<a id="org4866456"></a>
## Running batch simulations with Built-in demons
@@ -209,7 +209,7 @@ sasa -h | grep "\-demon"
--custom-demon, -custd
-<a id="org95fb51a"></a>
+<a id="orgf3df31d"></a>
## Running batch simulations with manual demons
@@ -236,7 +236,7 @@ It can also by simulated by [`lutin`](http://www-verimag.imag.fr/DIST-TOOLS/SYNC
Built-in demons can of course be programmed in Lutin. One can generate such demons using the `--gen-lutin-demon` option: `sasa --gen-lutin-demon a_graph.dot`. It can be handy at least to get the demons variables names in the good order if one to write its own demon.
-<a id="orgfcad4fc"></a>
+<a id="org9d9ef24"></a>
## Running batch simulations with `lurette`
@@ -259,14 +259,14 @@ lurette \
```
-<a id="org8048ac1"></a>
+<a id="org477c3d3"></a>
## Viewing Results
`sasa -rif` and `lurette` generates `.rif` files that can be viewed with `gnuplot-rif` or `sim2chro`; cf <http://www-verimag.imag.fr/DIST-TOOLS/SYNCHRONE/lustre-v6/>
-<a id="orge3e533c"></a>
+<a id="org262a057"></a>
## The `sasa` CLI
@@ -329,14 +329,14 @@ sasa --more
Display the version ocaml version sasa was compiled with and exit.
-<a id="orgc7e936e"></a>
+<a id="orgc6d5408"></a>
# Interactive mode
If you want to perform interactive session, you can launch `sasa` under the control of [rdbg](http://www-verimag.imag.fr/DIST-TOOLS/SYNCHRONE/rdbg/). Before reading this section, please read at least the [Basic usage Section if the rdbg documentation](http://www-verimag.imag.fr/DIST-TOOLS/SYNCHRONE/rdbg/README.html#Level0).
-<a id="orga377025"></a>
+<a id="org9b78bb5"></a>
## Example: use `rdbg` from the `test/alea-coloring/` directory
@@ -389,7 +389,7 @@ $ rdbg
Typing `[Enter]` will therefore also load the `rdbg_session.ml` file we have just been using.
-<a id="org4e448a1"></a>
+<a id="org2006456"></a>
## The exemples of test directory
@@ -400,7 +400,7 @@ The [test](https://gricad-gitlab.univ-grenoble-alpes.fr/verimag/synchrone/sasa/t
- `test/*/my-rdbg-tuning.ml`: includes `test/my-rdbg-tuning.ml` and defines commands specific to the example of the directory. Indeed, `rdbg`, once launched, first tries to read the content of the file name `my-rdbg-tuning.ml` (it it exists).
-<a id="orge05191d"></a>
+<a id="org964d57c"></a>
## Running interactive sessions with `rdbg`
@@ -417,7 +417,7 @@ The [test](https://gricad-gitlab.univ-grenoble-alpes.fr/verimag/synchrone/sasa/t
All those commands are defined in (the common) [test/my-rdbg-tuning.ml](https://gricad-gitlab.univ-grenoble-alpes.fr/verimag/synchrone/sasa/tree/master/test/my-rdbg-tuning.ml) that is included in (locals) `test/*/my-rdbg-tuning.ml` that are included in (generated) `test/*/rdbg-session.ml` files. `my-rdbg-tuning.ml` contains straigthforward `ocaml` code that defines various `rdbg` shortcuts to ease the simulation of `sasa` systems. Feel free to tailor those command to yours needs by modyfying the local `my-rdbg-tuning.ml`!
-<a id="orgadf3937"></a>
+<a id="orgf6c6506"></a>
## Getting `rdbg` on-line help
@@ -430,10 +430,10 @@ Here are 2 useful entry-points to rdbg on-line help:
(rdbg) l
```
- 316a766643f5ff31533fa480ce051652
+ ef6c2b943fb4eda627a5c5ff18890bdd
-<a id="org9c358cf"></a>
+<a id="org911eaed"></a>
## Useful Modules
@@ -460,12 +460,12 @@ Some modules, used by the sasa core engine, can be useful from `rdbg`.
</div>
-<a id="org612a386"></a>
+<a id="orgf00383a"></a>
# Install
-<a id="org6342735"></a>
+<a id="orgd5a02ba"></a>
## Via opam 2 (prefered method)
@@ -490,14 +490,14 @@ opam install -y rdbg lutin
```
-<a id="org9c12c34"></a>
+<a id="org4a9d80f"></a>
## Via docker
cf the Install section of [Synchrone Reactive Tool Box](http://www-verimag.imag.fr/DIST-TOOLS/SYNCHRONE/lustre-v6).
-<a id="org9d18133"></a>
+<a id="org0ce02ed"></a>
## From source
@@ -510,14 +510,14 @@ You will need:
- `rdbg`
- `lutin` (not for compiling actually, but for using sasa with custom demons)
-```shell
+```sh
opam install dune ocamlgraph rdbg lutin
```
One can mimick the content of the `test` job in the project [.gitlab-ci.yml Gitlab CI script](https://gricad-gitlab.univ-grenoble-alpes.fr/verimag/synchrone/sasa/tree/master/.gitlab-ci.yml).
-<a id="org17190c0"></a>
+<a id="orgc3319a2"></a>
# More
@@ -525,12 +525,12 @@ One can mimick the content of the `test` job in the project [.gitlab-ci.yml Gitl
- Sources: <https://gricad-gitlab.univ-grenoble-alpes.fr/verimag/synchrone/sasa>
-<a id="org0149295"></a>
+<a id="org76c8af0"></a>
# FAQ
-<a id="org87dd6d1"></a>
+<a id="org3a27f5b"></a>
## Is there a FAQ?
diff --git a/guides/users/README.org b/guides/users/README.org
index e9be4f4d..3b914eb7 100644
--- a/guides/users/README.org
+++ b/guides/users/README.org
@@ -500,7 +500,7 @@ You will need:
- =rdbg=
- =lutin= (not for compiling actually, but for using sasa with custom demons)
-#+BEGIN_SRC shell
+#+BEGIN_SRC sh
opam install dune ocamlgraph rdbg lutin
#+END_SRC
--
GitLab