Salome HOME
Copyright update 2022
[modules/smesh.git] / src / Tools / MGCleanerPlug / doc / conf.py.in
index 0f6894ffd1e074049f6d14370cf6e04a9cd79d17..3f0968e9b673b8cb1db2141f40cf05ce234669a6 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
@@ -24,6 +25,12 @@ import sys, os
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = ['sphinx.ext.autodoc']
+try:
+  import sphinx_rtd_theme
+  extensions += ['sphinx_rtd_theme']
+  use_rtd_theme = True
+except:
+  use_rtd_theme = False
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['.templates']
@@ -36,7 +43,7 @@ master_doc = 'index'
 
 # General substitutions.
 project = 'MGCleaner Plug-in'
-copyright = '2013-2017, EDF R&D'
+copyright = '2013-2022, EDF R&D'
 
 # The default replacements for |version| and |release|, also used in various
 # other places throughout the built documents.
@@ -50,7 +57,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 +87,19 @@ 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'.
+if use_rtd_theme:
+  html_theme = 'sphinx_rtd_theme'
+else:
+  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 +124,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.
@@ -158,7 +174,7 @@ htmlhelp_basename = 'MGCleanerPlug-in doc'
 # (source start file, target name, title, author, document class [howto/manual]).
 latex_documents = [
   ('index', 'MGCleanerPlugIn.tex', 'MGCleaner PlugIn Documentation',
-   'CEA', 'manual'),
+   'EDF R&D', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of