From b33015dc9d63987dd67c5763e269f705556c0e40 Mon Sep 17 00:00:00 2001
From: Bertrand Benjamin <benjamin.bertrand@opytex.org>
Date: Mon, 1 Jul 2019 09:12:08 +0200
Subject: [PATCH] Feat: starting rewrite doc

---
 documentation/source/index.rst                | 45 ++++++++++---------
 documentation/source/presentation_calculs.rst | 20 ++++++++-
 2 files changed, 43 insertions(+), 22 deletions(-)

diff --git a/documentation/source/index.rst b/documentation/source/index.rst
index 49b7ca7..3e474f0 100644
--- a/documentation/source/index.rst
+++ b/documentation/source/index.rst
@@ -8,39 +8,43 @@ Karibou dans la documentation de Mapytex
 
 Mapytex est un ensemble de modules écris en Python qui vise à faciliter et automatiser la conception d'exercices de math et leurs corrections. 
 
-C'est le moteur qui va permettre à `Opytex <../opytex/>`_ de manipuler les données créer pour faire ces exercices. Il est capable de créer aléatoirement des expressions (calculs de fractions, polynomes, expressions littérales...), des données statistiques et bientôt des figures géométriques, de les simplifier et de faire des calculs avec.
-
-À la difference d'un logiciel de calcul formel classique (comme `sympy <sympy.org>`_), Mapytex va non seulement être capable de simplifier des calculs mais surtout d'expliquer comme un élève les étapes qui permettent d'arriver au résultat.
-
 Le module est séparé en 3 parties:
 
 - *calculus*: Cette partie gère les expressions mathématiques et leurs calculs.
 
+  À la différence d'un logiciel de calcul formel classique (comme `sympy <sympy.org>`_), Mapytex va non seulement être capable de simplifier des calculs mais surtout d'expliquer comme un élève les étapes qui permettent d'arriver au résultat.
+
   Voici un exemple de création d'un exercice calculatoire avec des fractions.
 
   .. code-block:: python
 
-        >>> from pymath import Expression
+        >>> from mapytex import Expression
         >>> ajout_fraction = Expression.random("{a} + {b} / {c}")
         >>> print(ajout_fraction)
-        2 + \frac{ 3 }{ 5 }
-        >>> for i in ajout_fraction.simplify().explain():
-                print(i)
-        1 + \frac{ 3 }{ 5 }
-        \frac{ 1 \times 5 }{ 1 \times 5 } + \frac{ 3 \times 1 }{ 5 \times 1 }
-        \frac{ 5 }{ 5 } + \frac{ 3 }{ 5 }
-        \frac{ 5 + 3 }{ 5 }
-        \frac{ 8 }{ 5 }
+        - 1 + \frac{9}{- 5}
+        >>> res = ajout_fraction.simplify()
+        >>> print(res)
+        \frac{14}{- 5}
+        >>> for i in res.explain():
+        ...        print(i)
+        - 1 + \frac{9}{- 5}
+        \frac{- 1}{1} + \frac{9}{- 5}
+        \frac{- 1 \times - 5}{1 \times - 5} + \frac{9}{- 5}
+        \frac{5}{- 5} + \frac{9}{- 5}
+        \frac{5 + 9}{- 5}
+        \frac{14}{- 5}
+
 
   Ce qui donne une fois compilé avec Latex
 
     .. math::
         \begin{align*}
-            1 + \frac{ 3 }{ 5 } \\
-            \frac{ 1 \times 5 }{ 1 \times 5 } + \frac{ 3 \times 1 }{ 5 \times 1 } \\
-            \frac{ 5 }{ 5 } + \frac{ 3 }{ 5 } \\
-            \frac{ 5 + 3 }{ 5 } \\
-            \frac{ 8 }{ 5 }
+            - 1 + \frac{9}{- 5}\\
+            \frac{- 1}{1} + \frac{9}{- 5}\\
+            \frac{- 1 \times - 5}{1 \times - 5} + \frac{9}{- 5}\\
+            \frac{5}{- 5} + \frac{9}{- 5}\\
+            \frac{5 + 9}{- 5}\\
+            \frac{14}{- 5}
         \end{align*}
 
   Pour en savoir plus: `présentation des outils de calculs <presentation_calculs.html>`_
@@ -58,9 +62,10 @@ Le module est séparé en 3 parties:
 
   Pour en savoir plus: `présentation des outils stat <presentation_stat.html>`_
 
-- *geometry*: (non faite) Cette partie gère la création de situations géométriques.
+- *geometry*: Partie rudimentaire! Pour le moment, elle ne permet que de créer des triplets de Pythagore!
 
-Sommaire:
+Sommaire
+========
 
 .. toctree::
    :maxdepth: 2
diff --git a/documentation/source/presentation_calculs.rst b/documentation/source/presentation_calculs.rst
index 7b63df3..3ef4870 100644
--- a/documentation/source/presentation_calculs.rst
+++ b/documentation/source/presentation_calculs.rst
@@ -1,7 +1,23 @@
 Présentation des outils de calculs de Mapytex
-============================================
+=============================================
 
-La partie calcul de Mapytex est un module python qui permet la manipulation d'expressions mathématiques. Voici ce qu'il est capable de faire:
+La partie calcul de Mapytex est un module python qui permet la manipulation d'expressions mathématiques. 
+
+Une de mes motivations principales pour développer cet outil est de pouvoir créer des devoirs aléatoirement tout en mettant à disposition des élèves une correction personnalisée. Générer des exercices aléatoirement me permet de me concentre sur la direction que je veux leur donner (par exemple un exercice avec une addition de fractions avec un dénominateur commun) et de laisser python ventiler valeurs en fonction de contraintes que j'aurai défini.
+
+À la différence des logiciels de calcul formel classiques, ce module va être capable d'écrire les étapes qui mènent à la réponse.
+
+Calculs et explications
+-----------------------
+
+Types de données manipulables
+-----------------------------
+
+Génération aléatoire d'expressions
+----------------------------------
+
+Autres
+------
 
 -  *Calculer comme un collégien*: Pour faire de la correction automatisé
    d'exercice, un logiciel de calcul formel ne suffit pas. Si les étapes