Salome HOME
Avoid infinite loop, found with test NRT_GRIDS_GEOM_BUG15_R7
[modules/smesh.git] / src / Tools / ZCracksPlug / doc / conf.py.in
1 # -*- coding: utf-8 -*-
2 #
3 # Yams PlugIn documentation build configuration file, created by
4 # sphinx-quickstart on Wed Sep 14 11:40:32 2011.
5 #
6 # This file is execfile()d with the current directory set to its containing dir.
7 #
8 # The contents of this file are pickled, so don't put values in the namespace
9 # that aren't pickleable (module imports are okay, they're removed automatically).
10 #
11 # All configuration values have a default value; values that are commented out
12 # serve to show the default value.
13
14 import sys, os
15 import sphinx
16
17 # If your extensions are in another directory, add it here. If the directory
18 # is relative to the documentation root, use os.path.abspath to make it
19 # absolute, like shown here.
20 #sys.path.append(os.path.abspath('some/directory'))
21
22 # General configuration
23 # ---------------------
24
25 # Add any Sphinx extension module names here, as strings. They can be extensions
26 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
27 extensions = ['sphinx.ext.autodoc']
28 try:
29   import sphinx_rtd_theme
30   extensions += ['sphinx_rtd_theme']
31   use_rtd_theme = True
32 except:
33   use_rtd_theme = False
34
35 # Add any paths that contain templates here, relative to this directory.
36 templates_path = ['.templates']
37
38 # The suffix of source filenames.
39 source_suffix = '.rst'
40
41 # The master toctree document.
42 master_doc = 'index'
43
44 # General substitutions.
45 project = 'ZCracks Plug-in'
46 copyright = '2007-2021 EDF R&D'
47
48 # The default replacements for |version| and |release|, also used in various
49 # other places throughout the built documents.
50 #
51 # The short X.Y version.
52 version = '@SALOMESMESH_VERSION@'
53 # The full version, including alpha/beta/rc tags.
54 release = '@SALOMESMESH_VERSION@'
55
56 # There are two options for replacing |today|: either, you set today to some
57 # non-false value, then it is used:
58 #today = ''
59 # Else, today_fmt is used as the format for a strftime call.
60 today_fmt = '%B %d, %Y'
61
62 # List of documents that shouldn't be included in the build.
63 #unused_docs = []
64
65 # List of directories, relative to source directories, that shouldn't be searched
66 # for source files.
67 #exclude_dirs = []
68
69 # The reST default role (used for this markup: `text`) to use for all documents.
70 #default_role = None
71
72 # If true, '()' will be appended to :func: etc. cross-reference text.
73 #add_function_parentheses = True
74
75 # If true, the current module name will be prepended to all description
76 # unit titles (such as .. function::).
77 #add_module_names = True
78
79 # If true, sectionauthor and moduleauthor directives will be shown in the
80 # output. They are ignored by default.
81 #show_authors = False
82
83 # The name of the Pygments (syntax highlighting) style to use.
84 pygments_style = 'sphinx'
85
86
87 # Options for HTML output
88 # -----------------------
89
90 # The theme to use for HTML and HTML Help pages.  Major themes that come with
91 # Sphinx are currently 'default' and 'sphinxdoc'.
92 if use_rtd_theme:
93   html_theme = 'sphinx_rtd_theme'
94 else:
95   html_theme = 'default' if sphinx.version_info[:2] < (1,3) else 'classic'
96
97 themes_options = {}
98 themes_options['classic'] = {
99   'body_max_width':'none',
100   'body_min_width':0,
101 }
102 html_theme_options = themes_options.get(html_theme, {})
103
104 # The style sheet to use for HTML and HTML Help pages. A file of that name
105 # must exist either in Sphinx' static/ path, or in one of the custom paths
106 # given in html_static_path.
107 #html_style = 'default.css'
108
109 # The name for this set of Sphinx documents.  If None, it defaults to
110 # "<project> v<release> documentation".
111 #html_title = None
112
113 # A shorter title for the navigation bar.  Default is the same as html_title.
114 #html_short_title = None
115
116 # The name of an image file (within the static path) to place at the top of
117 # the sidebar.
118 #html_logo = None
119
120 # The name of an image file (within the static path) to use as favicon of the
121 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
122 # pixels large.
123 #html_favicon = None
124
125 # Add any paths that contain custom static files (such as style sheets) here,
126 # relative to this directory. They are copied after the builtin static files,
127 # so a file named "default.css" will overwrite the builtin "default.css".
128 #html_static_path = ['.static']
129
130 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
131 # using the given strftime format.
132 html_last_updated_fmt = '%b %d, %Y'
133
134 # If true, SmartyPants will be used to convert quotes and dashes to
135 # typographically correct entities.
136 #html_use_smartypants = True
137
138 # Custom sidebar templates, maps document names to template names.
139 #html_sidebars = {}
140
141 # Additional templates that should be rendered to pages, maps page names to
142 # template names.
143 #html_additional_pages = {}
144
145 # If false, no module index is generated.
146 #html_use_modindex = True
147
148 # If false, no index is generated.
149 #html_use_index = True
150
151 # If true, the index is split into individual pages for each letter.
152 #html_split_index = False
153
154 # If true, the reST sources are included in the HTML build as _sources/<name>.
155 #html_copy_source = True
156
157 # If true, an OpenSearch description file will be output, and all pages will
158 # contain a <link> tag referring to it.  The value of this option must be the
159 # base URL from which the finished HTML is served.
160 #html_use_opensearch = ''
161
162 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
163 #html_file_suffix = ''
164
165 # Output file base name for HTML help builder.
166 htmlhelp_basename = 'ZcracksPlug-in doc'
167
168
169 # Options for LaTeX output
170 # ------------------------
171
172 # The paper size ('letter' or 'a4').
173 #latex_paper_size = 'letter'
174
175 # The font size ('10pt', '11pt' or '12pt').
176 #latex_font_size = '10pt'
177
178 # Grouping the document tree into LaTeX files. List of tuples
179 # (source start file, target name, title, author, document class [howto/manual]).
180 latex_documents = [
181   ('index', 'ZCRACKSPlugIn.tex', 'ZCracks PlugIn Documentation',
182    'Pascale Noyret', 'manual'),
183 ]
184
185 # The name of an image file (relative to this directory) to place at the top of
186 # the title page.
187 #latex_logo = None
188
189 # For "manual" documents, if this is true, then toplevel headings are parts,
190 # not chapters.
191 #latex_use_parts = False
192
193 # Additional stuff for the LaTeX preamble.
194 #latex_preamble = ''
195
196 # Documents to append as an appendix to all manuals.
197 #latex_appendices = []
198
199 # If false, no module index is generated.
200 #latex_use_modindex = True