mirror of
https://git.salome-platform.org/gitpub/modules/smesh.git
synced 2024-12-25 08:50:35 +05:00
bos #18858 Use sphinx_rtd_theme as theme for SALOME documentation built with Sphinx
This commit is contained in:
parent
d07d6a9662
commit
d792abb5a2
@ -30,7 +30,12 @@ try:
|
|||||||
extensions += ['sphinxcontrib.napoleon']
|
extensions += ['sphinxcontrib.napoleon']
|
||||||
except:
|
except:
|
||||||
pass
|
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
|
#add pdfbuilder to build a pdf with rst2pdf
|
||||||
#extensions = ['rst2pdf.pdfbuilder']
|
#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
|
# The theme to use for HTML and HTML Help pages. Major themes that come with
|
||||||
# Sphinx are currently 'default' and 'sphinxdoc'.
|
# 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 = {}
|
||||||
themes_options['classic'] = {
|
themes_options['classic'] = {
|
||||||
'body_max_width':'none',
|
'body_max_width':'none',
|
||||||
|
@ -25,6 +25,12 @@ import sphinx
|
|||||||
# Add any Sphinx extension module names here, as strings. They can be extensions
|
# Add any Sphinx extension module names here, as strings. They can be extensions
|
||||||
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
||||||
extensions = ['sphinx.ext.autodoc']
|
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.
|
# Add any paths that contain templates here, relative to this directory.
|
||||||
templates_path = ['.templates']
|
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
|
# The theme to use for HTML and HTML Help pages. Major themes that come with
|
||||||
# Sphinx are currently 'default' and 'sphinxdoc'.
|
# 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 = {}
|
||||||
themes_options['classic'] = {
|
themes_options['classic'] = {
|
||||||
'body_max_width':'none',
|
'body_max_width':'none',
|
||||||
|
@ -25,6 +25,12 @@ import sphinx
|
|||||||
# Add any Sphinx extension module names here, as strings. They can be extensions
|
# Add any Sphinx extension module names here, as strings. They can be extensions
|
||||||
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
||||||
extensions = ['sphinx.ext.autodoc']
|
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.
|
# Add any paths that contain templates here, relative to this directory.
|
||||||
templates_path = ['.templates']
|
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
|
# The theme to use for HTML and HTML Help pages. Major themes that come with
|
||||||
# Sphinx are currently 'default' and 'sphinxdoc'.
|
# 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 = {}
|
||||||
themes_options['classic'] = {
|
themes_options['classic'] = {
|
||||||
'body_max_width':'none',
|
'body_max_width':'none',
|
||||||
|
@ -25,6 +25,12 @@ import sphinx
|
|||||||
# Add any Sphinx extension module names here, as strings. They can be extensions
|
# Add any Sphinx extension module names here, as strings. They can be extensions
|
||||||
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
||||||
extensions = ['sphinx.ext.autodoc']
|
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.
|
# Add any paths that contain templates here, relative to this directory.
|
||||||
templates_path = ['.templates']
|
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
|
# The theme to use for HTML and HTML Help pages. Major themes that come with
|
||||||
# Sphinx are currently 'default' and 'sphinxdoc'.
|
# 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 = {}
|
||||||
themes_options['classic'] = {
|
themes_options['classic'] = {
|
||||||
'body_max_width':'none',
|
'body_max_width':'none',
|
||||||
|
@ -12,6 +12,7 @@
|
|||||||
# serve to show the default value.
|
# serve to show the default value.
|
||||||
|
|
||||||
import sys, os
|
import sys, os
|
||||||
|
import sphinx
|
||||||
|
|
||||||
# If your extensions are in another directory, add it here. If the directory
|
# 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
|
# 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
|
# Add any Sphinx extension module names here, as strings. They can be extensions
|
||||||
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
||||||
extensions = ['sphinx.ext.autodoc']
|
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.
|
# Add any paths that contain templates here, relative to this directory.
|
||||||
templates_path = ['.templates']
|
templates_path = ['.templates']
|
||||||
@ -80,10 +87,24 @@ pygments_style = 'sphinx'
|
|||||||
# Options for HTML output
|
# 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
|
# 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
|
# must exist either in Sphinx' static/ path, or in one of the custom paths
|
||||||
# given in html_static_path.
|
# 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
|
# The name for this set of Sphinx documents. If None, it defaults to
|
||||||
# "<project> v<release> documentation".
|
# "<project> v<release> documentation".
|
||||||
|
@ -24,6 +24,12 @@ import sys, os
|
|||||||
# Add any Sphinx extension module names here, as strings. They can be extensions
|
# Add any Sphinx extension module names here, as strings. They can be extensions
|
||||||
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
||||||
extensions = ['sphinx.ext.autodoc']
|
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.
|
# Add any paths that contain templates here, relative to this directory.
|
||||||
#templates_path = ['.templates']
|
#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
|
# 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
|
# must exist either in Sphinx' static/ path, or in one of the custom paths
|
||||||
# given in html_static_path.
|
# given in html_static_path.
|
||||||
#html_style = 'default'
|
if use_rtd_theme:
|
||||||
html_theme = 'default'
|
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
|
# The name for this set of Sphinx documents. If None, it defaults to
|
||||||
# "<project> v<release> documentation".
|
# "<project> v<release> documentation".
|
||||||
|
Loading…
Reference in New Issue
Block a user