From: vsr Date: Fri, 13 Mar 2020 13:06:58 +0000 (+0300) Subject: bos #18858 Use sphinx_rtd_theme as theme for SALOME documentation built with Sphinx X-Git-Tag: V9_5_0a2~38 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=ce08a54d4205924141f3c748edc256a9eaa5d312;p=modules%2Fshaper.git bos #18858 Use sphinx_rtd_theme as theme for SALOME documentation built with Sphinx --- diff --git a/doc/gui/conf.py.in b/doc/gui/conf.py.in index 799a1d593..97e16e27b 100644 --- a/doc/gui/conf.py.in +++ b/doc/gui/conf.py.in @@ -18,6 +18,7 @@ # import os import sys +import sphinx # sys.path.insert(0, os.path.abspath('.')) @@ -36,6 +37,12 @@ try: extensions += ['sphinxcontrib.napoleon'] except: pass +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 = [os.path.join('@CMAKE_CURRENT_SOURCE_DIR@','templates')] @@ -89,13 +96,21 @@ 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_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, +} +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, diff --git a/src/PythonAPI/doc/source/conf.py b/src/PythonAPI/doc/source/conf.py index a16b5f3eb..0f2c6144e 100644 --- a/src/PythonAPI/doc/source/conf.py +++ b/src/PythonAPI/doc/source/conf.py @@ -12,6 +12,7 @@ import sys import os +import sphinx # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the @@ -37,6 +38,12 @@ extensions = [ 'sphinx.ext.napoleon', 'sphinx.ext.autosummary', ] +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'] @@ -106,12 +113,20 @@ pygments_style = 'sphinx' # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'default' +if use_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, +} +html_theme_options = themes_options.get(html_theme, {}) # Add any paths that contain custom themes here, relative to this directory. #html_theme_path = []