bos #18858 Use sphinx_rtd_theme as theme for SALOME documentation built with Sphinx

This commit is contained in:
vsr 2020-03-13 14:12:39 +03:00
parent d07d6a9662
commit d792abb5a2
6 changed files with 83 additions and 8 deletions

View File

@ -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',

View File

@ -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',

View File

@ -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',

View File

@ -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',

View 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']
@ -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
# "<project> v<release> documentation".

View File

@ -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
# "<project> v<release> documentation".