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