[Getfem-commits] r4877 - in /trunk/getfem: bin/ doc/sphinx/source/ doc/sphinx/source/.templates/ doc/sphinx/source/matlab/ doc/sphinx/source/...

[Yves . Renard]

Author: renard
Date: Tue Mar 10 13:30:56 2015
New Revision: 4877

URL: http://svn.gna.org/viewcvs/getfem?rev=4877&view=rev
Log:
minor documentation changes

Modified:
    trunk/getfem/bin/extract_doc
    trunk/getfem/doc/sphinx/source/.templates/indexsidebar.html
    trunk/getfem/doc/sphinx/source/matlab/intro.rst
    trunk/getfem/doc/sphinx/source/python/examples.rst
    trunk/getfem/doc/sphinx/source/python/intro.rst
    trunk/getfem/doc/sphinx/source/replaces.txt
    trunk/getfem/doc/sphinx/source/scilab/intro.rst

Modified: trunk/getfem/bin/extract_doc
URL: 
http://svn.gna.org/viewcvs/getfem/trunk/getfem/bin/extract_doc?rev=4877&r1=4876&r2=4877&view=diff
==============================================================================
--- trunk/getfem/bin/extract_doc        (original)
+++ trunk/getfem/bin/extract_doc        Tue Mar 10 13:30:56 2015
@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 # -*- python -*-
 #
-# Copyright (C) 2004-2014 Yves Renard, Julien Pommier.
+# Copyright (C) 2004-2015 Yves Renard, Julien Pommier.
 #                                                       
 # This file is a part of GETFEM++                                         
 #                                                                         
@@ -869,6 +869,11 @@
   print 'Command reference'
   print '================='
   print ''
+  print 'Please remember that this documentation is not self contained.'
+  print 'You should in particular refer to the `user documentation`_ '
+  print 'to have a more extensive description of the structures algorithms '
+  print 'and concepts used.'
+  print ''
   print 'Types'
   print '-----'
   print ''
@@ -1374,6 +1379,11 @@
   print ''
   print 'Command reference'
   print '================='
+  print ''
+  print 'Please remember that this documentation is not self contained.'
+  print 'You should in particular refer to the `user documentation`_ '
+  print 'to have a more extensive description of the structures algorithms '
+  print 'and concepts used.'
   print ''
   print 'Types'
   print '-----'
@@ -1911,7 +1921,11 @@
   print "API reference"
   print "=============\n"
   print ''
-
+  print 'Please remember that this documentation is not self contained.'
+  print 'You should in particular refer to the `user documentation`_ '
+  print 'to have a more extensive description of the structures algorithms '
+  print 'and concepts used.'
+  print ''
 
   # one pass to find the set methods having identical name with a get method
   # in that case 'set_' is added to the set method.

Modified: trunk/getfem/doc/sphinx/source/.templates/indexsidebar.html
URL: 
http://svn.gna.org/viewcvs/getfem/trunk/getfem/doc/sphinx/source/.templates/indexsidebar.html?rev=4877&r1=4876&r2=4877&view=diff
==============================================================================
--- trunk/getfem/doc/sphinx/source/.templates/indexsidebar.html (original)
+++ trunk/getfem/doc/sphinx/source/.templates/indexsidebar.html Tue Mar 10 
13:30:56 2015
@@ -3,7 +3,7 @@
            <h3>Main documentations</h3>
            <ul>
               
-             <li><a href="{{ pathto('userdoc/index') }}">Getfem++ Basic User 
documentation</a></li>
+             <li><a href="{{ pathto('userdoc/index') }}">Getfem++ User 
documentation</a></li>
               <li><a href="{{ pathto('python/index') }}">Python 
Interface</a></li>
              <li><a href="{{ pathto('matlab/index') }}">Matlab 
Interface</a></li>
              <li><a href="{{ pathto('scilab/index') }}">Scilab 
Interface</a></li>

Modified: trunk/getfem/doc/sphinx/source/matlab/intro.rst
URL: 
http://svn.gna.org/viewcvs/getfem/trunk/getfem/doc/sphinx/source/matlab/intro.rst?rev=4877&r1=4876&r2=4877&view=diff
==============================================================================
--- trunk/getfem/doc/sphinx/source/matlab/intro.rst     (original)
+++ trunk/getfem/doc/sphinx/source/matlab/intro.rst     Tue Mar 10 13:30:56 2015
@@ -9,9 +9,12 @@
 Introduction
 ============
 
-This guide provides a reference about the |Mlab| interface of |gf|. For a 
complete 
-reference of |gf|, please report to the `specific guides`_, but you should be 
able 
-to use the |gfi|'s without any particular knowledge of the |gf| internals, 
-although a basic knowledge about Finite Elements is required.
+This guide provides a reference about the |Mlab| interface of |gf|.
+For a complete  reference of |gf|, please report to the `specific guides`_,
+but you should be able to use the |gfi|'s without any particular knowledge
+of the |gf| internals, although a basic knowledge about Finite Elements
+is required. This documentation is however not self contained. You should in
+particular refer to the `user documentation`_ to have a more extensive
+description of the structures algorithms and concepts used.
 
 .. include:: ../license.txt

Modified: trunk/getfem/doc/sphinx/source/python/examples.rst
URL: 
http://svn.gna.org/viewcvs/getfem/trunk/getfem/doc/sphinx/source/python/examples.rst?rev=4877&r1=4876&r2=4877&view=diff
==============================================================================
--- trunk/getfem/doc/sphinx/source/python/examples.rst  (original)
+++ trunk/getfem/doc/sphinx/source/python/examples.rst  Tue Mar 10 13:30:56 2015
@@ -10,6 +10,8 @@
 ========
 
 .. _py-laplacianexample:
+
+
 
 A step-by-step basic example
 ----------------------------
@@ -20,8 +22,7 @@
 the **py-file** of this example under the name **demo_step_by_step.py** in the 
 directory ``interface/tests/python/`` of the |gf| distribution.
 
-The first step is to **create a Mesh object**. Since |gf| does not come with 
its 
-own mesher, one has to rely on an external mesher (see ``getfem.Mesh('import', 
+The first step is to **create a Mesh object**. It is possible to create simple 
structured meshes or unstructured meshes for simple geometries (see 
``getfem.Mesh('generate', mesher_object mo, scalar h))``) or to rely on an 
external mesher (see ``getfem.Mesh('import', 
 string FORMAT, string FILENAME)``), or use very simple meshes. For this 
example, 
 we just consider a regular mesh\index{cartesian mesh} whose nodes are 
 :math:`\{x_{i=0\ldots10,j=0..10}=(i/10,j/10)\}`

Modified: trunk/getfem/doc/sphinx/source/python/intro.rst
URL: 
http://svn.gna.org/viewcvs/getfem/trunk/getfem/doc/sphinx/source/python/intro.rst?rev=4877&r1=4876&r2=4877&view=diff
==============================================================================
--- trunk/getfem/doc/sphinx/source/python/intro.rst     (original)
+++ trunk/getfem/doc/sphinx/source/python/intro.rst     Tue Mar 10 13:30:56 2015
@@ -12,6 +12,9 @@
 This guide provides a reference about the |py| interface of |gf|. For a 
complete 
 reference of |gf|, please report to the `specific guides`_, but you should be 
able 
 to use the |gfi|'s without any particular knowledge of the |gf| internals, 
-although a basic knowledge about Finite Elements is required.
+although a basic knowledge about Finite Elements is required. This 
documentation
+is however not self contained. You should in
+particular refer to the `user documentation`_ to have a more extensive
+description of the structures algorithms and concepts used.
 
 .. include:: ../license.txt

Modified: trunk/getfem/doc/sphinx/source/replaces.txt
URL: 
http://svn.gna.org/viewcvs/getfem/trunk/getfem/doc/sphinx/source/replaces.txt?rev=4877&r1=4876&r2=4877&view=diff
==============================================================================
--- trunk/getfem/doc/sphinx/source/replaces.txt (original)
+++ trunk/getfem/doc/sphinx/source/replaces.txt Tue Mar 10 13:30:56 2015
@@ -84,6 +84,7 @@
 .. |mlab_mbr| replace:: gfMdBrick
 .. |mlab_ms| replace:: gfMdState
 .. _specific guides: http://download.gna.org/getfem/html/homepage/index.html
+.. _user documentation: 
http://download.gna.org/getfem/html/homepage/userdoc/index.html
 .. _vocabulary: http://download.gna.org/getfem/doc/getfem_reference/index.html
 .. _VTK: http://www.vtk.org
 .. _MayaVi: http://mayavi.sourceforge.net

Modified: trunk/getfem/doc/sphinx/source/scilab/intro.rst
URL: 
http://svn.gna.org/viewcvs/getfem/trunk/getfem/doc/sphinx/source/scilab/intro.rst?rev=4877&r1=4876&r2=4877&view=diff
==============================================================================
--- trunk/getfem/doc/sphinx/source/scilab/intro.rst     (original)
+++ trunk/getfem/doc/sphinx/source/scilab/intro.rst     Tue Mar 10 13:30:56 2015
@@ -8,6 +8,10 @@
 reference of |gf|, please report to the `specific guides`_, but you should be 
 able to use the scilab interface without any particular knowledge of the |gf| 
 internals, although a basic knowledge about Finite Elements is required.
+This documentation is however not self contained. You should in
+particular refer to the `user documentation`_ to have a more extensive
+description of the structures algorithms and concepts used.
+
 
 This documentation is still under construction. It is still a to close copy of 
the Matlab interface documentation.