-# -*- coding: utf-8 -*-
-
-## Copyright (C) 2014-2017 CEA/DEN, EDF R&D
-##
-## This library is free software; you can redistribute it and/or
-## modify it under the terms of the GNU Lesser General Public
-## License as published by the Free Software Foundation; either
-## version 2.1 of the License, or (at your option) any later version.
-##
-## This library is distributed in the hope that it will be useful,
-## but WITHOUT ANY WARRANTY; without even the implied warranty of
-## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-## Lesser General Public License for more details.
-##
-## You should have received a copy of the GNU Lesser General Public
-## License along with this library; if not, write to the Free Software
-## Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
-##
-## See http:##www.salome-platform.org/ or
-## email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
-##
-
-#
# Shaper python API documentation build configuration file, created by
# sphinx-quickstart on Thu Oct 15 11:55:42 2015.
#
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
'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']
master_doc = 'index'
# General information about the project.
-project = u'Shaper python API'
-copyright = u'2014-20xx CEA/DEN, EDF R&D'
+project = 'Shaper python API'
+copyright = '2014-2020 CEA/DEN, EDF R&D'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# 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 = []
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
- ('index', 'ShaperpythonAPI.tex', u'Shaper python API Documentation',
- u'Renaud Nédélec', 'manual'),
+ ('index', 'ShaperpythonAPI.tex', 'Shaper python API Documentation',
+ 'Renaud Nédélec', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
- ('index', 'shaperpythonapi', u'Shaper python API Documentation',
- [u'Renaud Nédélec'], 1)
+ ('index', 'shaperpythonapi', 'Shaper python API Documentation',
+ ['Renaud Nédélec'], 1)
]
# If true, show URL addresses after external links.
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
- ('index', 'ShaperpythonAPI', u'Shaper python API Documentation',
- u'Renaud Nédélec', 'ShaperpythonAPI', 'One line description of project.',
+ ('index', 'ShaperpythonAPI', 'Shaper python API Documentation',
+ 'Renaud Nédélec', 'ShaperpythonAPI', 'One line description of project.',
'Miscellaneous'),
]
