doc/en/conf.py

   1 # -*- coding: utf-8 -*-
   2 #
   3 # Copyright (C) 2008-2020 EDF R&D
   4 #
   5 # This file is part of SALOME ADAO module
   6 #
   7 # This library is free software; you can redistribute it and/or
   8 # modify it under the terms of the GNU Lesser General Public
   9 # License as published by the Free Software Foundation; either
  10 # version 2.1 of the License.
  11 #
  12 # This library is distributed in the hope that it will be useful,
  13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 # Lesser General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU Lesser General Public
  18 # License along with this library; if not, write to the Free Software
  19 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  20 #
  21 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  22 #
  23 # Author: Jean-Philippe Argaud, jean-philippe.argaud@edf.fr, EDF R&D
  24
  25 import sys, os, sphinx
  26 import sphinx_rtd_theme
  27
  28 try:
  29     sys.path.append(os.path.abspath("../../bin"))
  30     import module_version
  31     print("Import du module_version de bin...")
  32 except:
  33     pass
  34 try:
  35     sys.path.append(os.path.abspath("../../adao/adao/daCore"))
  36     import version as module_version
  37     print("Import du module_version de daCore...")
  38 except:
  39     pass
  40
  41 # -- Project information -----------------------------------------------------
  42
  43 project   = u'%s'%module_version.name
  44 author    = u'Jean-Philippe ARGAUD'
  45 copyright = u'2008-%s, EDF R&D, %s'%(module_version.year,author)
  46 version   = '%s'%module_version.version
  47 release   = '%s'%module_version.version
  48 doctitle  = u"%s documentation"%module_version.name
  49 docfull   = u"Aiding for Data Assimilation and Optimization"
  50
  51 # -- General configuration ---------------------------------------------------
  52
  53 from distutils.version import LooseVersion #, StrictVersion
  54 if LooseVersion(sphinx.__version__) < LooseVersion("1.4.0"):
  55     extensions = [
  56         'sphinx.ext.pngmath',
  57         'sphinx_rtd_theme',
  58     ]
  59 else:
  60     extensions = [
  61         'sphinx.ext.imgmath',
  62         'sphinx_rtd_theme',
  63         ]
  64 #
  65 source_suffix    = '.rst'
  66 source_encoding  = 'utf-8'
  67 master_doc       = 'index'
  68 language         = 'en'
  69 exclude_patterns = ['snippets', 'scripts', 'resources', '_build', 'Thumbs.db', '.DS_Store', 'Grenier']
  70 pygments_style   = None
  71 templates_path   = ['_templates']
  72 exclude_trees    = ['snippets',]
  73
  74 # -- Options for HTML output -------------------------------------------------
  75
  76 html_theme       = "sphinx_rtd_theme"
  77 # html_theme     = 'default'
  78 # html_theme     = 'alabaster'
  79 html_title       = doctitle
  80 html_static_path = ['_static']
  81 html_show_sourcelink = False
  82
  83 # -- Options for HTMLHelp output ---------------------------------------------
  84 htmlhelp_basename = 'ADAOdoc'
  85
  86 # -- Options for LaTeX output ------------------------------------------------
  87
  88 latex_elements = {
  89     'papersize': 'letterpaper',
  90     'pointsize': '10pt',
  91     'figure_align': 'htbp',
  92 }
  93 latex_documents = [
  94   ('index', 'ADAO.tex', doctitle,
  95    author, 'manual'),
  96 ]
  97
  98 # -- Options for manual page output ------------------------------------------
  99
 100 man_pages = [
 101     (master_doc, 'adao', doctitle,
 102      [author], 1)
 103 ]
 104
 105 # -- Options for Texinfo output ----------------------------------------------
 106 texinfo_documents = [
 107     (master_doc, 'ADAO', doctitle,
 108      author, 'ADAO', docfull,
 109      'Miscellaneous'),
 110 ]
 111 # -- Options for Epub output -------------------------------------------------
 112
 113 epub_title         = doctitle
 114 epub_author        = author
 115 epub_publisher     = author
 116 epub_copyright     = copyright
 117 epub_exclude_files = ['search.html']
 118
 119 # -- Options for PDF output --------------------------------------------------
 120
 121 pdf_documents = [
 122     ('contents', u'ADAO', u'ADAO', author, dict(pdf_compressed = True)),
 123 ]
 124 pdf_stylesheets = ['sphinx','kerning','a4']
 125 pdf_compressed = True
 126 pdf_inline_footnotes = True
 127
 128 # -- Extension configuration -------------------------------------------------