From 10dcc6c33a0315074bf7f6734471aa1dd52f24bf Mon Sep 17 00:00:00 2001 From: Gilles DAVID Date: Tue, 30 May 2017 13:07:19 +0200 Subject: [PATCH] Fix doc generation warnings and errors --- doc/dev/sphinx/fr/medcalc-develguide.rst | 8 ++++---- doc/dev/sphinx/fr/medcalc-specifications.rst | 4 ++-- doc/dev/sphinx/fr/medcalc-userguide-gui.rst | 14 +++++++------- doc/dev/sphinx/fr/medop-prototype-develguide.rst | 16 ++++++++-------- doc/dev/sphinx/fr/medop-prototype-medmem.rst | 2 +- doc/dev/sphinx/medcalc-develguide.rst | 8 ++++---- doc/dev/sphinx/medcalc-userguide-gui.rst | 12 ++++++------ 7 files changed, 32 insertions(+), 32 deletions(-) diff --git a/doc/dev/sphinx/fr/medcalc-develguide.rst b/doc/dev/sphinx/fr/medcalc-develguide.rst index 5fb1b0dbb..0037c7216 100644 --- a/doc/dev/sphinx/fr/medcalc-develguide.rst +++ b/doc/dev/sphinx/fr/medcalc-develguide.rst @@ -26,7 +26,7 @@ Mise en place de l'espace de développement ========================================== Gestion de configuration du composant MEDCalc -------------------------------------------- +--------------------------------------------- Le composant logiciel MEDCalc est un package du module SALOME MED, hébergé dans l'espace source au niveau du sous-répertoire @@ -34,7 +34,7 @@ hébergé dans l'espace source au niveau du sous-répertoire module SALOME MED. Organisation des sources du composant MEDCalc -------------------------------------------- +--------------------------------------------- Le répertoire source `src/MEDCalc` distingue les sous-répertoires suivants: @@ -49,13 +49,13 @@ suivants: MEDCalc framework Construction du composant MEDCalc -------------------------------- +--------------------------------- Intégré à la construction du module MED. Le composant MEDCalc dépend de MEDCoupling et MEDLoader uniquement. Exécution des tests unitaires du composant MEDCalc ------------------------------------------------- +-------------------------------------------------- Les tests unitaires peuvent être exécutés au moyen de scripts python lancés depuis une session shell SALOME. Dans un nouveau shell, taper:: diff --git a/doc/dev/sphinx/fr/medcalc-specifications.rst b/doc/dev/sphinx/fr/medcalc-specifications.rst index 6f53c66f1..2823a965f 100644 --- a/doc/dev/sphinx/fr/medcalc-specifications.rst +++ b/doc/dev/sphinx/fr/medcalc-specifications.rst @@ -145,7 +145,7 @@ de type valeur numérique. Par exemple, la formule ``W=OP(U,V)`` indique que le champ W est formé à partir des champs U et V en arguments d'une fonction OP. Dans le cas d'une opération algébrique comme l'addition (cf. :ref:`Spécification -des opérations`, le résultat attendu par défaut +des opérations`, le résultat attendu par défaut est que pour chaque instant t, chaque position p et chaque composante c, on a ``W(t,p,c)=U(t,p,c)+V(t,p,c)`` (que l'on peut noter également ``W(:,:,:)=U(:,:,:)+V(:,:,:)`` compte-tenu de la convention présentée @@ -347,7 +347,7 @@ Un scénario d'utilisation type est: tableaux de valeurs sauvegardés dans un fichier texte ou exporté sous forme de tableau numpy -.. _xmed-specifications: +.. _xmed-specifications-fr: Spécification des opérations ============================ diff --git a/doc/dev/sphinx/fr/medcalc-userguide-gui.rst b/doc/dev/sphinx/fr/medcalc-userguide-gui.rst index 0de116484..dcf1cbed8 100644 --- a/doc/dev/sphinx/fr/medcalc-userguide-gui.rst +++ b/doc/dev/sphinx/fr/medcalc-userguide-gui.rst @@ -222,7 +222,7 @@ champs sauvegardés. .. BUG: plantage à l'utilsation dans XMED d'un fichier rechargé .. (invalid mesh on field) -.. _xmed.userguide.exemple3: +.. _xmed.userguide.exemple3-fr: Exemple 3: Appliquer une opération mathématique sur des champs -------------------------------------------------------------- @@ -340,7 +340,7 @@ puis retour:: Elle peut également être utilisée comme argument des commandes de gestion disponibles dans l'interface textuelle (dont la liste détaillée est décrite à la section :ref:`Documentation de l'interface -textuelle`). Par exemple, la fonction ``view`` +textuelle`). Par exemple, la fonction ``view`` permet d'afficher la carte scalaire du champ dans le viewer:: >>> view(f3) @@ -400,9 +400,9 @@ différents, par exemple lorsqu'ils sont chargés de fichiers med différents. Pour traiter ce cas de figure, la bibliothèque MEDCoupling prévoit une fonction de "Changement du maillage support", dont l'utilisation au niveau du module de manipulation de champs est -illustrée dans :ref:`l'exemple 4` ci-après. +illustrée dans :ref:`l'exemple 4` ci-après. -.. _xmed.userguide.exemple4: +.. _xmed.userguide.exemple4-fr: Exemple 4: Comparer des champs issues de différentes sources ------------------------------------------------------------ @@ -431,7 +431,7 @@ géométriquement identiques. Or, les fonctions de manipulation de champs ne permettent pas les opérations sur des champs dont les maillages supports sont différents (voir la remarque à la fin de :ref:`l'exemple -3`). +3`). Pour résoudre ce cas de figure, le module de manipulation de champs met à disposition la fonction "Change underlying mesh" qui permet de @@ -479,7 +479,7 @@ En définitif, si ``f1`` désigne le champ issu du datasource ``parametric_01.med`` et ``f2`` le champ issu du datasource ``parametric_02.med`` par la procédure décrite ci-dessus, alors la comparaison des deux grandeurs peut être faite comme pour le cas de -:ref:`l'exemple 3`:: +:ref:`l'exemple 3`:: >>> r=f1-f2 >>> view(r) @@ -653,7 +653,7 @@ carte de champ: chargeant le fichier généré dans le module PARAVIS pour visualisation. -.. _xmed.userguide.tui: +.. _xmed.userguide.tui-fr: Utilisation de l'interface textuelle du module MED (TUI) ======================================================== diff --git a/doc/dev/sphinx/fr/medop-prototype-develguide.rst b/doc/dev/sphinx/fr/medop-prototype-develguide.rst index 60e09a3b8..cb27e2930 100644 --- a/doc/dev/sphinx/fr/medop-prototype-develguide.rst +++ b/doc/dev/sphinx/fr/medop-prototype-develguide.rst @@ -289,7 +289,7 @@ l'utilisateur pour désigner les champs dans les opérations. Ces classes proxy sont conçues pour être le lieu d'implémentation de l'interprétation des commandes utilisateur et donc de l'ergonomie de manipulation des champs au niveau l'interface textuelle. Ce point -est développé :ref:`plus bas `. +est développé :ref:`plus bas `. Programmation de l'interface textuelle -------------------------------------- @@ -312,9 +312,9 @@ graphique en images: .. |IMG_SELECT| image:: ../images/medop-gui-selectfield_scale.png .. |IMG_ALIAS| image:: ../images/medop-gui-aliasfield_scale.png -+---------------+---------------+ -| |IMG_SELECT| | |IMG_ALIAS| | -+---------------+---------------+ ++--------------+-------------+ +| |IMG_SELECT| | |IMG_ALIAS| | ++--------------+-------------+ L'image de gauche montre la sélection du pas de temps, l'image de droite la boîte de dialogue qui permet la saisie de l'alias avec @@ -423,7 +423,7 @@ associée à ce servant (en fait associée au servant ``SALOME_MED::MEDOP`` créé sur demande par le servant ``SALOME_MED::MED``, voir la fonction ``getFieldFromMed(...)``). -.. _develguide_execFieldOperation: +.. _develguide_execFieldOperation-fr: Exécution des opérations sur le champs -------------------------------------- @@ -543,9 +543,9 @@ module du champ dans l'exemple implémenté par défaut): .. |IMG_VISU| image:: ../images/medop-gui-visufield_scale.png .. |IMG_RESULT| image:: ../images/medop-gui-result_scale.png -+---------------+---------------+ -| |IMG_VISU| | |IMG_RESULT| | -+---------------+---------------+ ++------------+--------------+ +| |IMG_VISU| | |IMG_RESULT| | ++------------+--------------+ Cette fonction répond au besoin de contrôle interactif des résultats produits par les opérations de manipulation de champs. diff --git a/doc/dev/sphinx/fr/medop-prototype-medmem.rst b/doc/dev/sphinx/fr/medop-prototype-medmem.rst index 3e825e8cb..9b001ce43 100644 --- a/doc/dev/sphinx/fr/medop-prototype-medmem.rst +++ b/doc/dev/sphinx/fr/medop-prototype-medmem.rst @@ -291,7 +291,7 @@ Le passage des arguments par référence est une facilité d'écriture pour éviter de passer un pointeur tout en évitant la récopie des données de la variable. -.. _xmed-medmem_corbainterface: +.. _xmed-medmem_corbainterface-fr: L'interface CORBA SALOME_MED ============================ diff --git a/doc/dev/sphinx/medcalc-develguide.rst b/doc/dev/sphinx/medcalc-develguide.rst index 1984584f8..9e6bb54a6 100644 --- a/doc/dev/sphinx/medcalc-develguide.rst +++ b/doc/dev/sphinx/medcalc-develguide.rst @@ -26,7 +26,7 @@ Mise en place de l'espace de développement ========================================== Gestion de configuration du composant MEDCalc -------------------------------------------- +--------------------------------------------- Le composant logiciel MEDCalc est un package du module SALOME MED, hébergé dans l'espace source au niveau du sous-répertoire @@ -34,7 +34,7 @@ hébergé dans l'espace source au niveau du sous-répertoire module SALOME MED. Organisation des sources du composant MEDCalc -------------------------------------------- +--------------------------------------------- Le répertoire source `src/MEDCalc` distingue les sous-répertoires suivants: @@ -49,13 +49,13 @@ suivants: MEDCalc framework Construction du composant MEDCalc -------------------------------- +--------------------------------- Intégré à la construction du module MED. Le composant MEDCalc dépend de MEDCoupling et MEDLoader uniquement. Exécution des tests unitaires du composant MEDCalc ------------------------------------------------- +-------------------------------------------------- Les tests unitaires peuvent être exécutés au moyen de scripts python lancés depuis une session shell SALOME. Dans un nouveau shell, taper:: diff --git a/doc/dev/sphinx/medcalc-userguide-gui.rst b/doc/dev/sphinx/medcalc-userguide-gui.rst index 7a5de95c8..9efdc6a41 100644 --- a/doc/dev/sphinx/medcalc-userguide-gui.rst +++ b/doc/dev/sphinx/medcalc-userguide-gui.rst @@ -310,7 +310,7 @@ Results in: difference ``f3-f4``, then producing a scalar map preview using the function ``view``:: - >>> view(f3-f4) + >>> view(f3-f4) Finally the field data can be displayed using the command``print``:: @@ -571,13 +571,13 @@ Using the textual interface (TUI) All operations driven through GUI can be done (more or less easily) using TUI. The field manipulation module can even be used exclusively in textual mode. -.. - For this run the command:: + +For this run the command: $ /medop.sh -.. - This command opens a command console ``medop>``. A med file can be loaded and - manipulated, for example to create fields from file data. + +This command opens a command console ``medop>``. A med file can be loaded and +manipulated, for example to create fields from file data. Whatever textual or graphical mode is used, a typical workflow in console looks like the following instructions:: -- 2.39.2