]> SALOME platform Git repositories - modules/smesh.git/commitdiff
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)
committerChristophe Bourcier <christophe.bourcier@cea.fr>
Thu, 24 Jan 2019 08:57:53 +0000 (09:57 +0100)
- 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 535e528f468070659a1859a97b61d111b58723b0..d11dbd5c4bc1ac85e2813c3136f568d498f2c354 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 34178cfd3869fa890106ca34abf8edc26db509ad..8d71500e1b464698d8c0e045d191dc0cfb991177 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 29993f024e423f4299eaab29f65f9111280d0bfa..9ad66df95fd433cc5d595bd2598cfb1b1dc4f76d 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 45133412c28ecf9f65a062449b011a57659b18af..8da4e2ae949d06488440cbef8703c053f9e59937 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 0f6894ffd1e074049f6d14370cf6e04a9cd79d17..560450bf16faa9d7c55c9d7ea5777a0773e39964 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 5ab05f374bdd07cf5c11aea601f9bfeadbd6ea2e..75bbe51823fa03f2abb8d57c04c00c2f804ad157 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 c37726b9ee61455d53324a94ec6d1cc271e475e6..69383e76b2c8b050ee9049f59c79fa229ce00e7d 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 3e61d8fe96b1b9e63a73dc5e89cab2a7bd0ff44b..4969b7784bdc9bed82fe08390e97d5f7da811c83 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 dd67de87c8a2f0427bb96af5ee592f0792476a46..d4b53b638a55a943d5092f1427e39403d80e192d 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 d8a1f560cd4a67603d371d5f13c90bd975fca90d..c2af74a552e7ecbe929e5fe7dc7d79924a96377d 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 1b9442d8f36403f210d7910022ac3cf5622fa166..c977be26569ff63aef17b397a19938124183ee09 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 29453af2e7d523ed891cc34a04b9ddccf836c8cf..0dce217ade364e87b86ea4fbd89589a50de3cfd2 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 29d094d19b25e0b85c4f3ad424e0c9b22c3b986c..2a4b9928609f6a6daa8f4b3ef0237222c588af66 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 3770d70c26048f6a1e658d899b90cac23b1b6c3b..20074cd3b3ea3c5e598d9ace0c68086c02e4f108 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 0f1a012d276af4587a3ede1db84e92a7924091e1..1f28619277de11af515a190874719f068a579353 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 5a0c007f8a650bdef2cca1da28e85e12c3879c9d..623baeaa529510df8f3b524d78331706c3fb7037 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 e88021eb8f230c9fdfb49f54677ec7aa38a321a6..dd06084bd350c0a1a2d35bb27f900f8e053919c8 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 accd55b19d16c63ebb21aca19631918b4f1cd705..d6db7e5cecf77c80033e36d4571d149dd19d442a 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.