Salome HOME
Detect sphinx theme directly in conf.py.in file
[modules/homard.git] / doc / en / conf.py.in
index fc40711d397c9fa207c0a8316dbd9f6bbcbb85e1..650691b0c5e3ee318ceb220fc38db75e026eeb48 100644 (file)
@@ -1,4 +1,4 @@
-# -*- coding: iso-8859-1 -*-
+# -*- coding: utf-8 -*-
 #
 # HOMARD documentation build configuration file, created by
 # sphinx-quickstart on Tue Jan  5 08:51:14 2010.
@@ -12,6 +12,7 @@
 # serve to show the default.
 
 import sys, 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
@@ -31,23 +32,23 @@ templates_path = ['_templates']
 source_suffix = '.rst'
 
 # The encoding of source files.
-source_encoding = 'iso-8859-1'
+source_encoding = 'utf-8'
 
 # The master toctree document.
 master_doc = 'index'
 
 # General information about the project.
 project = u'HOMARD'
-copyright = u'1996, 2011, 2013, EDF R&D, G. Nicolas, T. Fouquet, P. Noyret'
+copyright = u'1996, 2011, 2018, EDF R&D, G. Nicolas, A. Martin Sanchez, T. Fouquet, P. Noyret'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = '@SHORT_VERSION@'
+version = '@SALOMEHOMARD_VERSION@'
 # The full version, including alpha/beta/rc tags.
-release = '@VERSION@'
+release = '@SALOMEHOMARD_VERSION@'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -91,7 +92,7 @@ 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'
+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
@@ -110,12 +111,14 @@ html_theme = 'default'
 
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
-#html_logo = None
+html_logo = None
+#html_logo = "../images/HOMARD.png"
 
 # The name of an image file (within the static path) to use as favicon of the
 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 # pixels large.
-#html_favicon = None
+html_favicon = None
+#html_favicon = "../images/homard_d.ico"
 
 # 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,
@@ -166,22 +169,23 @@ htmlhelp_basename = 'HOMARDdoc'
 
 # -- Options for LaTeX output --------------------------------------------------
 
-# The paper size ('letter' or 'a4').
-latex_paper_size = 'a4'
+# Paper size option of the document class ('a4paper' or 'letterpaper'), default 'letterpaper'.
+paper_size = 'a4paper'
 
-# The font size ('10pt', '11pt' or '12pt').
-#latex_font_size = '10pt'
+# Point size option of the document class ('10pt', '11pt' or '12pt'), default '10pt'.
+pointsize = '10pt'
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
   ('index', 'HOMARD.tex', u'HOMARD Documentation',
-   u'G. NICOLAS et T. FOUQUET', 'manual'),
+   u'G. NICOLAS, A. MARTIN SANCHEZ and T. FOUQUET', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
 # the title page.
-#latex_logo = None
+latex_logo = None
+#latex_logo = "../images/HOMARD.png"
 
 # For "manual" documents, if this is true, then toplevel headings are parts,
 # not chapters.