From e2d9946baaf5f2e45de9fbc639a8637f36f6397e Mon Sep 17 00:00:00 2001 From: "pascale.noyret" Date: Wed, 6 Sep 2017 11:54:27 +0200 Subject: [PATCH] structure des fichiers rst et copyright --- doc/conf.py.in | 2 +- doc/eficas_personnalisation.rst | 2 +- doc/eficas_presentation.rst | 4 ++-- doc/eficas_principles.rst | 22 +++++++++++----------- doc/eficas_rules.rst | 8 ++++---- doc/python_rules.rst | 6 +++--- 6 files changed, 22 insertions(+), 22 deletions(-) diff --git a/doc/conf.py.in b/doc/conf.py.in index 55081879..117bb327 100644 --- a/doc/conf.py.in +++ b/doc/conf.py.in @@ -36,7 +36,7 @@ master_doc = 'index' # General substitutions. project = 'EFICAS' -copyright = '2011, Pascale Noyret' +copyright = '2017, Pascale Noyret' # The default replacements for |version| and |release|, also used in various # other places throughout the built documents. diff --git a/doc/eficas_personnalisation.rst b/doc/eficas_personnalisation.rst index 1c2c207d..a5d25f94 100644 --- a/doc/eficas_personnalisation.rst +++ b/doc/eficas_personnalisation.rst @@ -1,5 +1,5 @@ your own custom EFICAS -======================= +====================== User can choose to custom Eficas. They can decide which catalogs they used and which pdf reading tool they prefer. diff --git a/doc/eficas_presentation.rst b/doc/eficas_presentation.rst index a5e95c01..184e3b91 100644 --- a/doc/eficas_presentation.rst +++ b/doc/eficas_presentation.rst @@ -1,5 +1,5 @@ What's EFICAS -============== +============= Name's origin ------------- @@ -10,7 +10,7 @@ It avoids misuse of commands which are not allowed in a given context. It insures integrity of the file. General Behaviour ------------------- +----------------- * Catalogs EFICAS can be used by multiple codes and handles with multiple versions of each code. It is customized with files named "Catalogue" : It contains all commands for a code. Each command has a name and parametres which are defined by developpers. diff --git a/doc/eficas_principles.rst b/doc/eficas_principles.rst index b7871b04..2c0de74a 100644 --- a/doc/eficas_principles.rst +++ b/doc/eficas_principles.rst @@ -6,7 +6,7 @@ As in many GUI, a menu widget can be either a pull-down menu or a standalone con Eficas allows you to write (and reread) an unvalid file. At any time, user can save its works. Choose a Code ---------------------- +------------- So try to build a new JDC. @@ -22,7 +22,7 @@ Choose a version of the Code :align: center Enter commands -------------------------- +--------------- Eficas main widget provided two distinct views: The left size always contains the JDC explorer as a tree view. The right widget contains all informations used by the user to constructs the JDC. It shows which commands are available and which :ref:`rules-label` have to be followed. Commands are append after this selected in the JDC tree. @@ -42,7 +42,7 @@ The user also can choose the way the commands are sorted, either by alphabetica :align: center Choosing command's keywords ---------------------------------- +--------------------------- For each command, EFICAS shows which keywords are available. @@ -63,7 +63,7 @@ or :align: center types of item in the JDC (Jeu De Commande) -------------------------------------------- +------------------------------------------ In JDC, you can have : @@ -103,7 +103,7 @@ described in the catalog. Attributes of a keyword ---------------------------- +----------------------- a parameter ("mot-clef simple") should have : @@ -156,7 +156,7 @@ Input data panel depends on both these attributes. It forces the user to enter a Color chart -------------- +----------- a very simple colors chart helps the user to know if a item is valid or not : @@ -177,7 +177,7 @@ a very simple colors chart helps the user to know if a item is valid or not : Context Menus --------------- +------------- In the JDC tree, Context menus (invoked by right-clicking) allow user to : - create comments in the tree @@ -190,7 +190,7 @@ In the JDC tree, Context menus (invoked by right-clicking) allow user to : Parameters ------------- +---------- The Users can define parameters. As parameters, Eficas accepts : @@ -213,7 +213,7 @@ To select the value in the modal dialog widget, highligh the corresponding line Import data from file ------------------------ +--------------------- The user also can import data from a ASCII text file by pushing button "Importer". He chooses to import part of or the complete file. @@ -222,7 +222,7 @@ The user also can import data from a ASCII text file by pushing button "Importer Reports ---------------------- +------- You have acces to - Rapport de Validation (Jdc Menu) : It resumes JDC errors @@ -234,7 +234,7 @@ You have acces to Multiples files ---------------------- +--------------- EFICAS allows you to open simultaneously files with differents catalogs : for example a file with Openturns Study catalog and a file for Openturns wrapper. The user also can easely swap from one file to another by clicking on its tab. diff --git a/doc/eficas_rules.rst b/doc/eficas_rules.rst index 489a0d46..303233db 100644 --- a/doc/eficas_rules.rst +++ b/doc/eficas_rules.rst @@ -1,8 +1,8 @@ .. _rules-label: -=============================== +============ Eficas rules -=============================== +============ All the rules can be combinated, creating more complicated rules. @@ -44,7 +44,7 @@ UN_PARMI EXCLUS --------- +------ EXCLUS means that, if one of the keyword is created, the other won't be allowed. @@ -98,7 +98,7 @@ PRESENT_PRESENT PRESENT_ABSENT ---------------- +-------------- the rule means that if the FIRST keyword is selected, the others aren't allowed. diff --git a/doc/python_rules.rst b/doc/python_rules.rst index 78d3342e..45165edc 100644 --- a/doc/python_rules.rst +++ b/doc/python_rules.rst @@ -1,8 +1,8 @@ .. _python-label: -=============================== +======================= rules for python syntax -=============================== +======================= Variable names and identifier are similar to those in many other languages : ---------------------------------------------------------------------------- @@ -24,7 +24,7 @@ Some identifiers are reserved words : - REGLE, VALIDATOR, - ETAPE, ENTITE -Python's way for assigning values to variables: +Python's way for assigning values to variables : ------------------------------------------------- * Keep in mind that .comm are python files. The simplest form of assignement is : variable = value -- 2.39.2