From: crouzet Date: Fri, 6 Dec 2019 16:24:59 +0000 (+0100) Subject: doc : maj numero de version et logos X-Git-Tag: 5.5.0 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=9bdb5edc6b90b89a06d1a8fa6dabb04757e990c3;p=tools%2Fsat.git doc : maj numero de version et logos --- diff --git a/doc/src/commands/template.rst b/doc/src/commands/template.rst new file mode 100644 index 0000000..f109292 --- /dev/null +++ b/doc/src/commands/template.rst @@ -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 --template PythonComponent --target + + 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. + diff --git a/doc/src/conf.py b/doc/src/conf.py index 5e37a67..94cf730 100644 --- a/doc/src/conf.py +++ b/doc/src/conf.py @@ -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 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 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 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 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 index 0000000..9ceaff0 Binary files /dev/null and b/doc/src/images/sat_v5.png differ diff --git a/doc/src/images/sat_v5_about.png b/doc/src/images/sat_v5_about.png index 681be86..f593d4a 100644 Binary files a/doc/src/images/sat_v5_about.png and b/doc/src/images/sat_v5_about.png differ diff --git a/doc/src/index.rst b/doc/src/index.rst index d997c6c..9a6c88a 100644 --- a/doc/src/index.rst +++ b/doc/src/index.rst @@ -6,9 +6,9 @@ .. toctree:: :maxdepth: 2 -************ -Salome Tools -************ +.. ********** +.. SalomeTool +.. ********** Welcome @@ -44,13 +44,6 @@ Documentation Using SAT Configuration -For SAT developers... ---------------------- - -.. toctree:: - :maxdepth: 1 - - Extending SAT with additional commands List of Commands ================ @@ -63,7 +56,6 @@ List of Commands prepare compile launcher - application log environ clean @@ -71,6 +63,7 @@ List of Commands generate init environ + template Release Notes @@ -79,7 +72,7 @@ Release Notes .. toctree:: :maxdepth: 1 - Release Notes 5.5.0 (in construction) + Release Notes 5.5.0 Release Notes 5.4.0 Release Notes 5.3.0 Release Notes 5.2.0 diff --git a/doc/src/release_notes/release_notes_5.5.0.rst b/doc/src/release_notes/release_notes_5.5.0.rst index 63e9d16..553d4f7 100644 --- a/doc/src/release_notes/release_notes_5.5.0.rst +++ b/doc/src/release_notes/release_notes_5.5.0.rst @@ -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 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 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 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**