doc/gui/conf.py.in

   1 # -*- coding: utf-8 -*-
   2 #
   3 # SHAPER documentation build configuration file, created by
   4 # sphinx-quickstart on Fri Aug  3 11:29:53 2018.
   5 #
   6 # This file is execfile()d with the current directory set to its
   7 # containing dir.
   8 #
   9 # Note that not all possible configuration values are present in this
  10 # autogenerated file.
  11 #
  12 # All configuration values have a default; values that are commented out
  13 # serve to show the default.
  14
  15 # If extensions (or modules to document with autodoc) are in another directory,
  16 # add these directories to sys.path here. If the directory is relative to the
  17 # documentation root, use os.path.abspath to make it absolute, like shown here.
  18 #
  19 import os
  20 import sys
  21 import sphinx
  22 # sys.path.insert(0, os.path.abspath('.'))
  23
  24
  25 # -- General configuration ------------------------------------------------
  26
  27 # If your documentation needs a minimal Sphinx version, state it here.
  28 #
  29 # needs_sphinx = '1.0'
  30
  31 # Add any Sphinx extension module names here, as strings. They can be
  32 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
  33 # ones.
  34 extensions = ['sphinx.ext.autodoc','sphinx.ext.autosummary']
  35 try:
  36   import sphinxcontrib.napoleon
  37   extensions += ['sphinxcontrib.napoleon']
  38 except:
  39   pass
  40 try:
  41   import sphinx_rtd_theme
  42   extensions += ['sphinx_rtd_theme']
  43   use_rtd_theme = True
  44 except:
  45   use_rtd_theme = False
  46
  47 # Add any paths that contain templates here, relative to this directory.
  48 #templates_path = [os.path.join('@CMAKE_CURRENT_SOURCE_DIR@','templates')]
  49
  50 # The suffix(es) of source filenames.
  51 # You can specify multiple suffix as a list of string:
  52 #
  53 # source_suffix = ['.rst', '.md']
  54 source_suffix = '.rst'
  55
  56 # The master toctree document.
  57 master_doc = 'index'
  58
  59 # General information about the project.
  60 project = u'SHAPER'
  61 copyright = u'2014-2020  CEA/DEN, EDF R&D'
  62
  63 # Copyright is shown via custom footer
  64 html_show_copyright = False
  65
  66 # The version info for the project you're documenting, acts as replacement for
  67 # |version| and |release|, also used in various other places throughout the
  68 # built documents.
  69 #
  70 # The short X.Y version.
  71 version = u'@SHAPER_Version@'
  72 # The full version, including alpha/beta/rc tags.
  73 release = u'@SHAPER_Version@'
  74
  75 # The language for content autogenerated by Sphinx. Refer to documentation
  76 # for a list of supported languages.
  77 #
  78 # This is also used if you do content translation via gettext catalogs.
  79 # Usually you set "language" from the command line for these cases.
  80 #language = None
  81
  82 # List of patterns, relative to source directory, that match files and
  83 # directories to ignore when looking for source files.
  84 # This patterns also effect to html_static_path and html_extra_path
  85 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
  86
  87 # The name of the Pygments (syntax highlighting) style to use.
  88 pygments_style = 'sphinx'
  89
  90 # If true, `todo` and `todoList` produce output, else they produce nothing.
  91 # todo_include_todos = False
  92
  93
  94 # -- Options for HTML output ----------------------------------------------
  95
  96 # The theme to use for HTML and HTML Help pages.  See the documentation for
  97 # a list of builtin themes.
  98 #
  99 if use_rtd_theme:
 100   html_theme = 'sphinx_rtd_theme'
 101 else:
 102   html_theme = 'default' if sphinx.version_info[:2] < (1,3) else 'classic'
 103
 104 # Theme options are theme-specific and customize the look and feel of a theme
 105 # further.  For a list of options available for each theme, see the
 106 # documentation.
 107 #
 108 themes_options = {}
 109 themes_options['classic'] = {
 110   'body_max_width':'none',
 111   'body_min_width':0,
 112 }
 113 themes_options['sphinx_rtd_theme'] = {
 114   'prev_next_buttons_location':'both',
 115 }
 116
 117 html_theme_options = themes_options.get(html_theme, {})
 118
 119 # Add any paths that contain custom static files (such as style sheets) here,
 120 # relative to this directory. They are copied after the builtin static files,
 121 # so a file named "default.css" will overwrite the builtin "default.css".
 122 #html_static_path = [os.path.join('@CMAKE_CURRENT_BINARY_DIR@','static')]
 123
 124
 125 # -- Options for HTMLHelp output ------------------------------------------
 126
 127 # Output file base name for HTML help builder.
 128 htmlhelp_basename = 'SHAPERdoc'
 129
 130
 131 # -- Options for LaTeX output ---------------------------------------------
 132
 133 # The paper size ('letter' or 'a4').
 134 latex_paper_size = 'a4'
 135
 136 # The font size ('10pt', '11pt' or '12pt').
 137 latex_font_size = '10pt'
 138
 139 # Grouping the document tree into LaTeX files. List of tuples
 140 # (source start file, target name, title, author, document class [howto/manual]).
 141 latex_documents = [
 142   ('index', 'SHAPER.tex', 'SHAPER User Documentation', '', 'manual'),
 143 ]
 144
 145 # Grouping the document tree into LaTeX files. List of tuples
 146 # (source start file, target name, title,
 147 #  author, documentclass [howto, manual, or own class]).
 148 latex_documents = [
 149     (master_doc, 'SHAPER.tex', u'SHAPER Documentation',
 150      u'vsv', 'manual'),
 151 ]
 152
 153
 154 # -- Options for manual page output ---------------------------------------
 155
 156 # One entry per manual page. List of tuples
 157 # (source start file, name, description, authors, manual section).
 158 #man_pages = [
 159 #    (master_doc, 'shaper', u'SHAPER Documentation',
 160 #     [author], 1)
 161 #]
 162
 163
 164 # -- Options for Texinfo output -------------------------------------------
 165
 166 # Grouping the document tree into Texinfo files. List of tuples
 167 # (source start file, target name, title, author,
 168 #  dir menu entry, description, category)
 169 #texinfo_documents = [
 170 #    (master_doc, 'SHAPER', u'SHAPER Documentation',
 171 #     author, 'SHAPER', 'One line description of project.',
 172 #     'Miscellaneous'),
 173 #]