From d792abb5a260a959222321523a649ac38283953f Mon Sep 17 00:00:00 2001 From: vsr Date: Fri, 13 Mar 2020 14:12:39 +0300 Subject: [PATCH] bos #18858 Use sphinx_rtd_theme as theme for SALOME documentation built with Sphinx --- doc/salome/gui/SMESH/conf.py.in | 13 +++++++++++-- src/Tools/MGCleanerPlug/doc/conf.py.in | 12 +++++++++++- src/Tools/Verima/Doc/conf.py.in | 12 +++++++++++- src/Tools/YamsPlug/doc/conf.py.in | 12 +++++++++++- src/Tools/ZCracksPlug/doc/conf.py.in | 23 ++++++++++++++++++++++- src/Tools/blocFissure/doc/conf.py.in | 19 +++++++++++++++++-- 6 files changed, 83 insertions(+), 8 deletions(-) diff --git a/doc/salome/gui/SMESH/conf.py.in b/doc/salome/gui/SMESH/conf.py.in index d11dbd5c4..66efe32d3 100644 --- a/doc/salome/gui/SMESH/conf.py.in +++ b/doc/salome/gui/SMESH/conf.py.in @@ -30,7 +30,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 pdfbuilder to build a pdf with rst2pdf #extensions = ['rst2pdf.pdfbuilder'] @@ -106,7 +111,11 @@ pygments_style = 'sphinx' # 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' +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', diff --git a/src/Tools/MGCleanerPlug/doc/conf.py.in b/src/Tools/MGCleanerPlug/doc/conf.py.in index 560450bf1..173f096b5 100644 --- a/src/Tools/MGCleanerPlug/doc/conf.py.in +++ b/src/Tools/MGCleanerPlug/doc/conf.py.in @@ -25,6 +25,12 @@ import sphinx # 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'] @@ -83,7 +89,11 @@ pygments_style = 'sphinx' # 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' +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', diff --git a/src/Tools/Verima/Doc/conf.py.in b/src/Tools/Verima/Doc/conf.py.in index d4b53b638..47e27b664 100644 --- a/src/Tools/Verima/Doc/conf.py.in +++ b/src/Tools/Verima/Doc/conf.py.in @@ -25,6 +25,12 @@ import sphinx # 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'] @@ -83,7 +89,11 @@ pygments_style = 'sphinx' # 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' +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', diff --git a/src/Tools/YamsPlug/doc/conf.py.in b/src/Tools/YamsPlug/doc/conf.py.in index 2a4b99286..1241b2c6f 100644 --- a/src/Tools/YamsPlug/doc/conf.py.in +++ b/src/Tools/YamsPlug/doc/conf.py.in @@ -25,6 +25,12 @@ import sphinx # 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'] @@ -83,7 +89,11 @@ pygments_style = 'sphinx' # 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' +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', diff --git a/src/Tools/ZCracksPlug/doc/conf.py.in b/src/Tools/ZCracksPlug/doc/conf.py.in index db09764fc..0fe90574e 100644 --- a/src/Tools/ZCracksPlug/doc/conf.py.in +++ b/src/Tools/ZCracksPlug/doc/conf.py.in @@ -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'] @@ -80,10 +87,24 @@ pygments_style = 'sphinx' # Options for HTML output # ----------------------- +# 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 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' +#html_style = 'default.css' # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". diff --git a/src/Tools/blocFissure/doc/conf.py.in b/src/Tools/blocFissure/doc/conf.py.in index d6db7e5ce..07f6864d3 100644 --- a/src/Tools/blocFissure/doc/conf.py.in +++ b/src/Tools/blocFissure/doc/conf.py.in @@ -24,6 +24,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'] @@ -83,8 +89,17 @@ pygments_style = 'sphinx' # 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' -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' + +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 # " v documentation". -- 2.30.2