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