From: Jean-Philippe ARGAUD <jean-philippe.argaud@edf.fr>
Date: Thu, 29 Mar 2012 13:12:14 +0000 (+0200)
Subject: Improvements of the documentation
X-Git-Tag: V6_5_0~20^2~4
X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=9ac3f9a2ae81e1024b1ec4ffd4b8136124fdf864;p=modules%2Fadao.git

Improvements of the documentation
---

diff --git a/doc/conf.py b/doc/conf.py
index e7d68ef..0c62fb6 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -167,7 +167,7 @@ html_static_path = ['_static']
 #html_split_index = False
 
 # If true, links to the reST sources are added to the pages.
-#html_show_sourcelink = True
+html_show_sourcelink = False
 
 # If true, an OpenSearch description file will be output, and all pages will
 # contain a <link> tag referring to it.  The value of this option must be the
diff --git a/doc/examples.rst b/doc/examples.rst
index 882a48e..8e937d8 100644
--- a/doc/examples.rst
+++ b/doc/examples.rst
@@ -1,7 +1,7 @@
 .. _section_examples:
 
 ================================================================================
-Examples on using the ADAO module
+Tutorials on using the ADAO module
 ================================================================================
 
 .. |eficas_new| image:: images/eficas_new.png
@@ -117,7 +117,7 @@ definition. In order to do that, right click on the name of the file case in the
 "*Object browser*" window, and choose the "*Export to YACS*" sub-menu (or the
 "*Export to YACS*" button |eficas_yacs|) as below:
 
-  .. _adao_exporttoyacs:
+  .. _adao_exporttoyacs00:
   .. image:: images/adao_exporttoyacs.png
     :align: center
     :scale: 75%
diff --git a/doc/images/ADAO_logo.png b/doc/images/ADAO_logo.png
new file mode 100644
index 0000000..59abee8
Binary files /dev/null and b/doc/images/ADAO_logo.png differ
diff --git a/doc/index.rst b/doc/index.rst
index 0a23529..dfd8abf 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -1,11 +1,14 @@
-
 ================================================================================
 ADAO module documentation
 ================================================================================
 
+.. image:: images/ADAO_logo.png
+   :align: center
+   :scale: 10%
+
 The ADAO module provides **data assimilation** features in SALOME context. It is
-based on usage of other SALOME modules, namely YACS and EFICAS, and on an
-extensible generic underlying data assimilation library.
+based on usage of other SALOME modules, namely YACS and EFICAS, and on usage of
+a generic underlying data assimilation library.
 
 Briefly stated, Data Assimilation is a methodological framework to compute the
 optimal estimate of the inaccessible true value of a system state over time. It
@@ -30,6 +33,9 @@ without making difference. Matrices are written either normally, or with a
 condensed notation, consisting in the use of a space to separate values and a
 "``;``" to separate the rows, in a continuous line.
 
+Table of contents
+-----------------
+
 .. toctree::
    :maxdepth: 2
 
@@ -41,7 +47,7 @@ condensed notation, consisting in the use of a space to separate values and a
    bibliography
 
 Indices and tables
-================================================================================
+------------------
 
 * :ref:`genindex`
 * :ref:`search`
diff --git a/doc/using.rst b/doc/using.rst
index d1e40e6..6b91cef 100644
--- a/doc/using.rst
+++ b/doc/using.rst
@@ -43,13 +43,13 @@ Activate the ADAO module and use the editor GUI
 +++++++++++++++++++++++++++++++++++++++++++++++
 
 As always for a module, it has to be activated by choosing the appropriate
-module button (or menu) in the toolbar of SALOME. A popup appears, allowing to
-choose between creating a new study, or opening an already existing one:
+module button (or menu) in the toolbar of SALOME. If there is no study loaded, a
+popup appears, allowing to choose between creating a new study, or opening an
+already existing one:
 
   .. _adao_activate1:
   .. image:: images/adao_activate.png
     :align: center
-    :width: 100%
   .. centered::
     **Activating the module ADAO in SALOME**
 
@@ -111,12 +111,12 @@ using the "*Export to YACS*" button |eficas_yacs|, or equivalently choose the
 "*Export to YACS*" entry in the "*ADAO*" main menu, or in the contextual case
 menu in the object browser.
 
-  .. _adao_exporttoyacs:
+  .. _adao_exporttoyacs01:
   .. image:: images/adao_exporttoyacs.png
     :align: center
     :scale: 75%
   .. centered::
-    **"Export to YACS" submenu to generate the YACS scheme from the ADAO case**
+    **"Export to YACS" sub-menu to generate the YACS scheme from the ADAO case**
 
 This will lead to automatically generate an XML file for the YACS scheme, and
 open YACS module on this file. The YACS file will be stored in the same