Salome HOME
Small fixes in sphinx documentation of python plugins:
authorChristophe Bourcier <christophe.bourcier@cea.fr>
Thu, 24 Jan 2019 08:57:53 +0000 (09:57 +0100)
committervsr <vsr@opencascade.com>
Fri, 8 Feb 2019 11:20:05 +0000 (14:20 +0300)
- remove depedency to babel (only used to generated a date format)
- add missing theme
- remove warnings

18 files changed:
doc/salome/gui/SMESH/conf.py.in
src/Tools/MGCleanerPlug/doc/Advanced_params.rst
src/Tools/MGCleanerPlug/doc/CMakeLists.txt
src/Tools/MGCleanerPlug/doc/Generics_params.rst
src/Tools/MGCleanerPlug/doc/conf.py.in
src/Tools/MGCleanerPlug/doc/editHypo.rst
src/Tools/MGCleanerPlug/doc/lct.rst
src/Tools/Verima/Doc/CMakeLists.txt
src/Tools/Verima/Doc/conf.py.in
src/Tools/YamsPlug/doc/Advanced_params.rst
src/Tools/YamsPlug/doc/CMakeLists.txt
src/Tools/YamsPlug/doc/Generics_params.rst
src/Tools/YamsPlug/doc/conf.py.in
src/Tools/YamsPlug/doc/editHypo.rst
src/Tools/YamsPlug/doc/lct.rst
src/Tools/ZCracksPlug/doc/CMakeLists.txt
src/Tools/blocFissure/doc/CMakeLists.txt
src/Tools/blocFissure/doc/conf.py.in

index 535e528..d11dbd5 100644 (file)
@@ -178,7 +178,7 @@ htmlhelp_basename = 'smeshdoc'
 # ------------------------
 
 # The paper size ('letter' or 'a4').
-latex_paper_size = 'a4'
+#latex_paper_size = 'a4'
 
 # The font size ('10pt', '11pt' or '12pt').
 latex_font_size = '10pt'
index 34178cf..8d71500 100644 (file)
@@ -1,7 +1,8 @@
-Advanced Remeshing Options 
+Advanced Remeshing Options
 ==========================
 
 See tooltips comments for each parameter.
+
 See also :download:`MG-cleaner user manual <files/mg-cleaner_user_manual.pdf>`.
 
 .. image:: images/Advanced.png
index 29993f0..9ad66df 100755 (executable)
@@ -19,7 +19,7 @@
 
 SALOME_CONFIGURE_FILE(conf.py.in conf.py)
 
-SET(_cmd_options -c ${CMAKE_CURRENT_BINARY_DIR} -b html -d doctrees -D latex_paper_size=a4 ${CMAKE_CURRENT_SOURCE_DIR} docutils)
+SET(_cmd_options -c ${CMAKE_CURRENT_BINARY_DIR} -b html -d doctrees ${CMAKE_CURRENT_SOURCE_DIR} docutils)
 SALOME_GENERATE_ENVIRONMENT_SCRIPT(_cmd env_script "${SPHINX_EXECUTABLE}" "${_cmd_options}")            
 
 ADD_CUSTOM_TARGET(html_docs_MGCleanerPlug COMMAND ${_cmd})
index 4513341..8da4e2a 100644 (file)
@@ -1,17 +1,15 @@
-Generic  Options
-=================
+Generic Options
+===============
 
 These options are not meshing options but allow the user to configure control parameters for MG-Cleaner.
 
-
 - **Verbosity Level**
 
-This parameter (between 0 and 10) indicates the amount of information that MG-Cleaner prints during the run.
-    
-    
-- **File** 
+  This parameter (between 0 and 10) indicates the amount of information that MG-Cleaner prints during the run.
+
+- **File**
 
-You can change the file used to store your favorite remeshing hypothesis. see paragraph :ref:`hypothesis-label` for further informations.
+  You can change the file used to store your favorite remeshing hypothesis. see paragraph :ref:`hypothesis-label` for further informations.
 
 .. image:: images/Generic.png
    :align: center
index 0f6894f..560450b 100644 (file)
@@ -12,6 +12,7 @@
 # serve to show the default value.
 
 import sys, os
+import sphinx
 
 # If your extensions are in another directory, add it here. If the directory
 # is relative to the documentation root, use os.path.abspath to make it
@@ -50,7 +51,7 @@ release = '@SALOMESMESH_VERSION@'
 # non-false value, then it is used:
 #today = ''
 # Else, today_fmt is used as the format for a strftime call.
-today_fmt = '%B %d, %Y'
+#today_fmt = '%B %d, %Y'
 
 # List of documents that shouldn't be included in the build.
 #unused_docs = []
@@ -80,10 +81,15 @@ pygments_style = 'sphinx'
 # Options for HTML output
 # -----------------------
 
-# The style sheet to use for HTML and HTML Help pages. A file of that name
-# must exist either in Sphinx' static/ path, or in one of the custom paths
-# given in html_static_path.
-html_style = 'default.css'
+# The theme to use for HTML and HTML Help pages.  Major themes that come with
+# Sphinx are currently 'default' and 'sphinxdoc'.
+html_theme = 'default' if sphinx.version_info[:2] < (1,3) else 'classic'
+themes_options = {}
+themes_options['classic'] = {
+  'body_max_width':'none',
+  'body_min_width':0,
+}
+html_theme_options = themes_options.get(html_theme, {})
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
@@ -108,7 +114,7 @@ html_style = 'default.css'
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
-html_last_updated_fmt = '%b %d, %Y'
+#html_last_updated_fmt = '%b %d, %Y'
 
 # If true, SmartyPants will be used to convert quotes and dashes to
 # typographically correct entities.
index 5ab05f3..75bbe51 100644 (file)
@@ -1,8 +1,8 @@
 .. _hypothesis-label:
 
-===========================
-How to save MG-Cleaner Parameters 
-===========================
+=================================
+How to save MG-Cleaner Parameters
+=================================
 
 MG-Cleaner hypothesis is not meshing hypothesis for Salome, but hypothesis for MG-Cleaner.
 The current set of parameters is automatically written in the salome study object browser when you run computation.
index c37726b..69383e7 100644 (file)
@@ -1,5 +1,5 @@
-Running MGCleaner Plug-in 
-=====================
+Running MGCleaner Plug-in
+=========================
 
 MGCleaner plug-in can be invoked via SMESH Plugin item in Mesh menu bar 
 
index 3e61d8f..4969b77 100755 (executable)
@@ -19,7 +19,7 @@
 
 SALOME_CONFIGURE_FILE(conf.py.in conf.py)
 
-SET(_cmd_options -c ${CMAKE_CURRENT_BINARY_DIR} -b html -d doctrees -D latex_paper_size=a4 ${CMAKE_CURRENT_SOURCE_DIR} docutils)
+SET(_cmd_options -c ${CMAKE_CURRENT_BINARY_DIR} -b html -d doctrees ${CMAKE_CURRENT_SOURCE_DIR} docutils)
 SALOME_GENERATE_ENVIRONMENT_SCRIPT(_cmd env_script "${SPHINX_EXECUTABLE}" "${_cmd_options}")            
 
 ADD_CUSTOM_TARGET(html_docs_Verima COMMAND ${_cmd})
index dd67de8..d4b53b6 100644 (file)
@@ -12,6 +12,7 @@
 # serve to show the default value.
 
 import sys, os
+import sphinx
 
 # If your extensions are in another directory, add it here. If the directory
 # is relative to the documentation root, use os.path.abspath to make it
@@ -50,7 +51,7 @@ release = '@SALOMESMESH_VERSION@'
 # non-false value, then it is used:
 #today = ''
 # Else, today_fmt is used as the format for a strftime call.
-today_fmt = '%B %d, %Y'
+#today_fmt = '%B %d, %Y'
 
 # List of documents that shouldn't be included in the build.
 #unused_docs = []
@@ -80,10 +81,15 @@ pygments_style = 'sphinx'
 # Options for HTML output
 # -----------------------
 
-# The style sheet to use for HTML and HTML Help pages. A file of that name
-# must exist either in Sphinx' static/ path, or in one of the custom paths
-# given in html_static_path.
-html_style = 'default.css'
+# The theme to use for HTML and HTML Help pages.  Major themes that come with
+# Sphinx are currently 'default' and 'sphinxdoc'.
+html_theme = 'default' if sphinx.version_info[:2] < (1,3) else 'classic'
+themes_options = {}
+themes_options['classic'] = {
+  'body_max_width':'none',
+  'body_min_width':0,
+}
+html_theme_options = themes_options.get(html_theme, {})
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
@@ -108,7 +114,7 @@ html_style = 'default.css'
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
-html_last_updated_fmt = '%b %d, %Y'
+#html_last_updated_fmt = '%b %d, %Y'
 
 # If true, SmartyPants will be used to convert quotes and dashes to
 # typographically correct entities.
index d8a1f56..c2af74a 100644 (file)
@@ -1,45 +1,45 @@
-Advanced Remeshing Options 
+Advanced Remeshing Options
 ==========================
 
-.. note:: 
+.. note::
   Be aware that no control of coherency is done when you set these parameters : for instance, geometrical approximation is only allowed when SurfOpt computes a mesh for finite elements but the GUI will let you choose geometrical approximation and compute a visualisation mesh. See Distene's documentation for more details : 
   :download:`MeshGems-SurfOpt: The automatic surface remeshing tool of the MeshGems Suite <files/mg-surfopt_user_manual.pdf>`.
 
-  
+
 - **Ridge detection**
-if not set (ridge detection disabled ), MeshGems-SurfOpt will not try to detect any new ridge edge by its own mechanism : 
-it will consider as ridge only the ridges given in the mesh.  All non-ridge edges that would have been detected as ridge by the Ridge angle parameter (see below split edge)  will be considered as part of the same continuous patch.  This option should not be checked when all the known ridges of the mesh are given and when all other possible ridges are not geometric ridges to take into account.
+
+  if not set (ridge detection disabled ), MeshGems-SurfOpt will not try to detect any new ridge edge by its own mechanism :
+  it will consider as ridge only the ridges given in the mesh.  All non-ridge edges that would have been detected as ridge by the Ridge angle parameter (see below split edge)  will be considered as part of the same continuous patch.  This option should not be checked when all the known ridges of the mesh are given and when all other possible ridges are not geometric ridges to take into account.
 
 - **Point smoothing**
-When not set (point smoothing is disabled), MeshGems-SurfOpt will not try to move the initial given vertices (along an edge, a ridge or onto the surface), hence MeshGems-SurfOpt will only swap edges, remove vertices or add vertices (refines) to change the mesh.
+
+  When not set (point smoothing is disabled), MeshGems-SurfOpt will not try to move the initial given vertices (along an edge, a ridge or onto the surface), hence MeshGems-SurfOpt will only swap edges, remove vertices or add vertices (refines) to change the mesh.
 
 - **Geometrical  approximation**
-this field as well as the Chordal deviation tolerance parameter,enables the user to bound the maximal chordal deviation allowed. it avoids having sharp angles. , that is, the maximal distance allowed between the detected curve and the plane of the corresponding mesh face. It avoids having faces too far away from the curve they represent.
+
+  this field as well as the Chordal deviation tolerance parameter,enables the user to bound the maximal chordal deviation allowed. it avoids having sharp angles. , that is, the maximal distance allowed between the detected curve and the plane of the corresponding mesh face. It avoids having faces too far away from the curve they represent.
 
 .. image:: images/Tolerance.png
    :align: center
 
-
 This parameter P enables the user to specify the maximal chordal deviation  E relatively to the local curvature. the maximal chordal deviation will be set to E=P x r (r is the radius of the circumcercle) if the units parameter is set to relative or E=P if the units parameter is set to absolute.
 
-
 - **Ridge angle**
 
-This parameter specifies the angular values  for the automatic detection of ridges and corners. A ridge is automatically detected if the angle between the normal vectors of two adjacent faces exceeds this value.
-
+  This parameter specifies the angular values  for the automatic detection of ridges and corners. A ridge is automatically detected if the angle between the normal vectors of two adjacent faces exceeds this value.
 
 - **Maximal/Minimal size around vertices**
 
-These two parameters allow the user to prescribe a Maximal/Minimal size for the mesh elements, ie the lengths of the edges. 
-
+  These two parameters allow the user to prescribe a Maximal/Minimal size for the mesh elements, ie the lengths of the edges. 
 
 - **Mesh gradation**
-This parameter P controls the element size variation : MeshGems-SurfOpt will avoid having two adjacent edges which sizes vary more than the given gradation. A size correction is applied to the size map : if two adjacent edges are respectively e1 and e2 long and e2 > Pxe1, then, the new size for the second edge will be set to P x e1.
-**This procedure is deactivated if P=-1**
 
+  This parameter P controls the element size variation : MeshGems-SurfOpt will avoid having two adjacent edges which sizes vary more than the given gradation. A size correction is applied to the size map : if two adjacent edges are respectively e1 and e2 long and e2 > Pxe1, then, the new size for the second edge will be set to P x e1.
 
+  **This procedure is deactivated if P=-1**
 
 - **Split edge**
-If this option is activated, MeshGems-SurfOpt creates new vertices placed on the curved surface and adds them to elements.
-It may be used to obtain higher order elements.
+
+  If this option is activated, MeshGems-SurfOpt creates new vertices placed on the curved surface and adds them to elements.
+  It may be used to obtain higher order elements.
 
index 1b9442d..c977be2 100755 (executable)
@@ -19,7 +19,7 @@
 
 SALOME_CONFIGURE_FILE(conf.py.in conf.py)
 
-SET(_cmd_options -c ${CMAKE_CURRENT_BINARY_DIR} -b html -d doctrees -D latex_paper_size=a4 ${CMAKE_CURRENT_SOURCE_DIR} docutils)
+SET(_cmd_options -c ${CMAKE_CURRENT_BINARY_DIR} -b html -d doctrees ${CMAKE_CURRENT_SOURCE_DIR} docutils)
 SALOME_GENERATE_ENVIRONMENT_SCRIPT(_cmd env_script "${SPHINX_EXECUTABLE}" "${_cmd_options}")            
 
 ADD_CUSTOM_TARGET(html_docs_YamsPlug COMMAND ${_cmd})
index 29453af..0dce217 100644 (file)
@@ -1,21 +1,19 @@
-Generic  Options
-=================
+Generic Options
+===============
 
 These options are not meshing options but allow the user to configure control parameters for MeshGems-SurfOpt.
 
-
 - **Verbosity Level**
 
-This parameter (between 0 and 10) indicates the amount of information that MeshGems-SurfOpt prints during the run.
-
+  This parameter (between 0 and 10) indicates the amount of information that MeshGems-SurfOpt prints during the run.
 
 - **Memory Size**
-You usually don't have to set this parameter but you can choose to limit the amount of memory used by MeshGems-SurfOpt -- It requires 370 bytes per node. Or, if you try to enrich a already big mesh (up to 2 millions nodes), you exceptionally, need to allocate more memory.
-    
-    
-- **File** 
 
-You can change the file used to store remeshing hypotheses, see :ref:`hypothesis-label` for further information.
+  You usually don't have to set this parameter but you can choose to limit the amount of memory used by MeshGems-SurfOpt -- It requires 370 bytes per node. Or, if you try to enrich a already big mesh (up to 2 millions nodes), you exceptionally, need to allocate more memory.
+
+- **File**
+
+  You can change the file used to store remeshing hypotheses, see :ref:`hypothesis-label` for further information.
 
 .. image:: images/Generic.png
    :align: center
index 29d094d..2a4b992 100644 (file)
@@ -12,6 +12,7 @@
 # serve to show the default value.
 
 import sys, os
+import sphinx
 
 # If your extensions are in another directory, add it here. If the directory
 # is relative to the documentation root, use os.path.abspath to make it
@@ -50,7 +51,7 @@ release = '@SALOMESMESH_VERSION@'
 # non-false value, then it is used:
 #today = ''
 # Else, today_fmt is used as the format for a strftime call.
-today_fmt = '%B %d, %Y'
+#today_fmt = '%B %d, %Y'
 
 # List of documents that shouldn't be included in the build.
 #unused_docs = []
@@ -80,10 +81,15 @@ pygments_style = 'sphinx'
 # Options for HTML output
 # -----------------------
 
-# The style sheet to use for HTML and HTML Help pages. A file of that name
-# must exist either in Sphinx' static/ path, or in one of the custom paths
-# given in html_static_path.
-html_style = 'default.css'
+# The theme to use for HTML and HTML Help pages.  Major themes that come with
+# Sphinx are currently 'default' and 'sphinxdoc'.
+html_theme = 'default' if sphinx.version_info[:2] < (1,3) else 'classic'
+themes_options = {}
+themes_options['classic'] = {
+  'body_max_width':'none',
+  'body_min_width':0,
+}
+html_theme_options = themes_options.get(html_theme, {})
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
@@ -108,7 +114,7 @@ html_style = 'default.css'
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
-html_last_updated_fmt = '%b %d, %Y'
+#html_last_updated_fmt = '%b %d, %Y'
 
 # If true, SmartyPants will be used to convert quotes and dashes to
 # typographically correct entities.
index 3770d70..20074cd 100644 (file)
@@ -1,8 +1,8 @@
 .. _hypothesis-label:
 
-===========================
-How to save MeshGems-SurfOpt Parameters 
-===========================
+=======================================
+How to save MeshGems-SurfOpt Parameters
+=======================================
 
 MeshGems-SurfOpt hypothesis is not a meshing hypothesis for Salome, but an hypothesis for MeshGems-SurfOpt.
 The current set of parameters is automatically written in the salome study object browser when you run computation.
index 0f1a012..1f28619 100644 (file)
@@ -1,5 +1,5 @@
-Running MeshGems-SurfOpt Plug-in 
-=====================
+Running MeshGems-SurfOpt Plug-in
+================================
 
 MeshGems-SurfOpt plug-in can be invoked via SMESH Plugin item in Mesh menu bar 
 
index 5a0c007..623baea 100755 (executable)
@@ -19,7 +19,7 @@
 
 SALOME_CONFIGURE_FILE(conf.py.in conf.py)
 
-SET(_cmd_options -c ${CMAKE_CURRENT_BINARY_DIR} -b html -d doctrees -D latex_paper_size=a4 ${CMAKE_CURRENT_SOURCE_DIR} docutils)
+SET(_cmd_options -c ${CMAKE_CURRENT_BINARY_DIR} -b html -d doctrees ${CMAKE_CURRENT_SOURCE_DIR} docutils)
 SALOME_GENERATE_ENVIRONMENT_SCRIPT(_cmd env_script "${SPHINX_EXECUTABLE}" "${_cmd_options}")            
 
 ADD_CUSTOM_TARGET(html_docs_ZCracksPlug COMMAND ${_cmd})
index e88021e..dd06084 100755 (executable)
@@ -19,7 +19,7 @@
 
 SALOME_CONFIGURE_FILE(conf.py.in conf.py)
 
-SET(_cmd_options -c ${CMAKE_CURRENT_BINARY_DIR} -b html -d doctrees -D latex_paper_size=a4 ${CMAKE_CURRENT_SOURCE_DIR} docutils)
+SET(_cmd_options -c ${CMAKE_CURRENT_BINARY_DIR} -b html -d doctrees ${CMAKE_CURRENT_SOURCE_DIR} docutils)
 SALOME_GENERATE_ENVIRONMENT_SCRIPT(_cmd env_script "${SPHINX_EXECUTABLE}" "${_cmd_options}")            
 
 ADD_CUSTOM_TARGET(html_docs_blocFissure COMMAND ${_cmd})
index accd55b..d6db7e5 100644 (file)
@@ -50,7 +50,7 @@ release = '@SALOMESMESH_VERSION@'
 # non-false value, then it is used:
 #today = ''
 # Else, today_fmt is used as the format for a strftime call.
-today_fmt = '%B %d, %Y'
+#today_fmt = '%B %d, %Y'
 
 # List of documents that shouldn't be included in the build.
 #unused_docs = []
@@ -105,11 +105,11 @@ html_theme = 'default'
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+#html_static_path = ['_static']
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
-html_last_updated_fmt = '%b %d, %Y'
+#html_last_updated_fmt = '%b %d, %Y'
 
 # If true, SmartyPants will be used to convert quotes and dashes to
 # typographically correct entities.