Salome HOME
doc : maj numero de version et logos 5.5.0 V9_4_0
authorcrouzet <nicolas.crouzet@cea.fr>
Fri, 6 Dec 2019 16:24:59 +0000 (17:24 +0100)
committercrouzet <nicolas.crouzet@cea.fr>
Fri, 6 Dec 2019 16:24:59 +0000 (17:24 +0100)
doc/src/commands/template.rst [new file with mode: 0644]
doc/src/conf.py
doc/src/images/icon_applogo_sat.png [new file with mode: 0644]
doc/src/images/icon_applogo_sat_major_minor.png [new file with mode: 0644]
doc/src/images/sat_v5.5.png [new file with mode: 0644]
doc/src/images/sat_v5.5_about.png [new file with mode: 0644]
doc/src/images/sat_v5.png [new file with mode: 0644]
doc/src/images/sat_v5_about.png
doc/src/index.rst
doc/src/release_notes/release_notes_5.5.0.rst

diff --git a/doc/src/commands/template.rst b/doc/src/commands/template.rst
new file mode 100644 (file)
index 0000000..f109292
--- /dev/null
@@ -0,0 +1,22 @@
+
+.. include:: ../../rst_prolog.rst
+
+Command template
+****************
+
+Description
+===========
+The **template** command generates the sources of a SALOME module out of a template.
+SAT provides two templates for SALOME 9 :
+
+* PythonComponent : a complete template for a SALOME module implemented in python (with data model and GUI)
+* CppComponent : a template for a SALOME component implemented in C++, with a code coupling API 
+
+Usage
+=====
+* Create a python SALOME module: ::
+
+    sat template --name <product_name> --template PythonComponent --target <my_directory>
+    
+  Create in *my_directory* a ready to use SALOME module implemented in python. The generated module can then be adapted to the needs, and pushed in a git repository.
+
index 5e37a670f6e503cebd01c0ba2256733a65c2d582..94cf73080172c4f36b24085f69a46efca7d72474 100644 (file)
@@ -61,9 +61,9 @@ copyright = u'2019, CEA'
 # built documents.
 #
 # The short X.Y version.
-version = '5.4'
+version = '5.5'
 # The full version, including alpha/beta/rc tags.
-release = '5.4.0'
+release = '5.5.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -143,7 +143,7 @@ html_theme_path = ["../_themes/alabaster", ]
 
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
-html_logo = "images/sat_v5.0.png"
+html_logo = "images/sat_v5.png"
 
 # The name of an image file (within the static path) to use as favicon of the
 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
@@ -226,7 +226,7 @@ latex_elements = {
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
-  ('index', 'salomeTools.tex', u'salomeTools Documentation',
+  ('index', 'salomeTools.tex', u'SAT Documentation',
    u'CEA DEN/DANS/DM2S/STMF/LGLS', 'manual'),
 ]
 
@@ -259,7 +259,7 @@ latex_show_urls = 'footnote' # sphinx version 1.7 # True
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('index', 'salometools', u'salomeTools Documentation',
+    ('index', 'salometools', u'SAT Documentation',
      [u'CEA DEN/DANS/DM2S/STMF/LGLS'], 1)
 ]
 
diff --git a/doc/src/images/icon_applogo_sat.png b/doc/src/images/icon_applogo_sat.png
new file mode 100644 (file)
index 0000000..41243ff
Binary files /dev/null and b/doc/src/images/icon_applogo_sat.png differ
diff --git a/doc/src/images/icon_applogo_sat_major_minor.png b/doc/src/images/icon_applogo_sat_major_minor.png
new file mode 100644 (file)
index 0000000..6d05a12
Binary files /dev/null and b/doc/src/images/icon_applogo_sat_major_minor.png differ
diff --git a/doc/src/images/sat_v5.5.png b/doc/src/images/sat_v5.5.png
new file mode 100644 (file)
index 0000000..ba7978e
Binary files /dev/null and b/doc/src/images/sat_v5.5.png differ
diff --git a/doc/src/images/sat_v5.5_about.png b/doc/src/images/sat_v5.5_about.png
new file mode 100644 (file)
index 0000000..05448fe
Binary files /dev/null and b/doc/src/images/sat_v5.5_about.png differ
diff --git a/doc/src/images/sat_v5.png b/doc/src/images/sat_v5.png
new file mode 100644 (file)
index 0000000..9ceaff0
Binary files /dev/null and b/doc/src/images/sat_v5.png differ
index 681be86185e1a7584ba6615aaa1a373e73dfd8f2..f593d4a4b36d6f791a5b234cf5051e6104cd1d48 100644 (file)
Binary files a/doc/src/images/sat_v5_about.png and b/doc/src/images/sat_v5_about.png differ
index d997c6cbb2fc7f167b9450009f2a06ab3b0659b7..9a6c88abb8d81ea5cf9d02c331ea9de325f6a2e5 100644 (file)
@@ -6,9 +6,9 @@
 .. toctree::
    :maxdepth: 2
 
-************
-Salome Tools
-************
+.. **********
+.. SalomeTool
+.. **********
 
 
 Welcome
@@ -44,13 +44,6 @@ Documentation
    Using SAT <usage_of_sat>
    Configuration <configuration>
 
-For SAT developers...
----------------------
-
-.. toctree::
-   :maxdepth: 1
-
-   Extending SAT with additional commands <write_command>
 
 List of Commands
 ================
@@ -63,7 +56,6 @@ List of Commands
    prepare <commands/prepare>
    compile <commands/compile>
    launcher <commands/launcher>
-   application <commands/application>
    log <commands/log>
    environ <commands/environ>
    clean <commands/clean>
@@ -71,6 +63,7 @@ List of Commands
    generate <commands/generate>
    init <commands/init>
    environ <commands/environ>
+   template <commands/template>
 
 
 Release Notes
@@ -79,7 +72,7 @@ Release Notes
 .. toctree::
    :maxdepth: 1
 
-   Release Notes 5.5.0 (in construction) <release_notes/release_notes_5.5.0>
+   Release Notes 5.5.0 <release_notes/release_notes_5.5.0>
    Release Notes 5.4.0 <release_notes/release_notes_5.4.0>
    Release Notes 5.3.0 <release_notes/release_notes_5.3.0>
    Release Notes 5.2.0 <release_notes/release_notes_5.2.0>
index 63e9d160e3067bd1daac6b7360274e4e068a35f5..553d4f782a8c02deaa69af51d3c9450d878d6806 100644 (file)
@@ -25,8 +25,7 @@ This second property is usefull on windows platform to reduce the length of pyth
 
 After several tests anf iterations, the following management was adopted:
  - sat prepare <application> does nothing for pip products (because at prepare time we don't have python compiled, and the use of native pip may not be compatible).
- - sat compile <application> use the pip module installed in python to get pip archives (wheels), store them in local archive directory, and install then either in python
-directory, or in the product directory (in accordance to pip_install_dir property).
+ - sat compile <application> use the pip module installed in python to get pip archives (wheels), store them in local archive directory, and install then either in python directory, or in the product directory (in accordance to pip_install_dir property).
 
 
 **single directory mode**