Salome HOME
bos #23972 [CEA 19980] sphinxcontrib_napoleon is not needed with Sphinx >= 1.3
[modules/shaper.git] / doc / gui / conf.py.in
index ed3e6fd5b6636b7c7a27bccaf935020c80c5d11e..a96b6ef5b38625f82884572b415ec4528fb1ce2e 100644 (file)
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
+
+import importlib
 import os
 import sys
+import sphinx
 # sys.path.insert(0, os.path.abspath('.'))
 
 
@@ -31,14 +34,22 @@ import sys
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = ['sphinx.ext.autodoc','sphinx.ext.autosummary']
-try:
-  import sphinxcontrib.napoleon
-  extensions += ['sphinxcontrib.napoleon']
-except:
-  pass
+# Optional extensions
+extra_extensions = ['sphinx_rtd_theme']
+if sphinx.version_info[:2] < (1,3):
+    extra_extensions += ['sphinxcontrib.napoleon']
+else:
+    extra_extensions += ['sphinx.ext.napoleon']
+for ext in extra_extensions:
+    try:
+        importlib.import_module(ext)
+        extensions.append(ext)
+        globals().update({'use_{}'.format(ext):True})
+    except:
+        globals().update({'use_{}'.format(ext):False})
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = [os.path.join('@CMAKE_CURRENT_SOURCE_DIR@','templates')]
+#templates_path = [os.path.join('@CMAKE_CURRENT_SOURCE_DIR@','templates')]
 
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
@@ -51,7 +62,7 @@ master_doc = 'index'
 
 # General information about the project.
 project = u'SHAPER'
-copyright = u'2014-2019  CEA/DEN, EDF R&D'
+copyright = u'2014-2020  CEA/DEN, EDF R&D'
 
 # Copyright is shown via custom footer
 html_show_copyright = False
@@ -61,9 +72,9 @@ html_show_copyright = False
 # built documents.
 #
 # The short X.Y version.
-version = u'3.0.0'
+version = u'@SHAPER_VERSION@'
 # The full version, including alpha/beta/rc tags.
-release = u'3.0.0'
+release = u'@SHAPER_VERSION@'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -89,18 +100,30 @@ pygments_style = 'sphinx'
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = '@SPHINX_THEME@'
+if use_sphinx_rtd_theme:
+  html_theme = 'sphinx_rtd_theme'
+else:
+  html_theme = 'default' if sphinx.version_info[:2] < (1,3) else 'classic'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
 #
-# html_theme_options = {}
+themes_options = {}
+themes_options['classic'] = {
+  'body_max_width':'none',
+  'body_min_width':0,
+}
+themes_options['sphinx_rtd_theme'] = {
+  'prev_next_buttons_location':'both',
+}
+
+html_theme_options = themes_options.get(html_theme, {})
 
 # 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 = [os.path.join('@CMAKE_CURRENT_BINARY_DIR@','static')]
+#html_static_path = [os.path.join('@CMAKE_CURRENT_BINARY_DIR@','static')]
 
 
 # -- Options for HTMLHelp output ------------------------------------------