Salome HOME
bos #26630 EDF 6032 - Problem of projection
[modules/smesh.git] / doc / salome / gui / SMESH / conf.py.in
1 # -*- coding: utf-8 -*-
2 #
3 # yacs documentation build configuration file, created by
4 # sphinx-quickstart on Fri Aug 29 09:57:25 2008.
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; values that are commented out
12 # serve to show the default.
13
14 import importlib
15 import sys, os
16 import sphinx
17
18 # If your extensions are in another directory, add it here. If the directory
19 # is relative to the documentation root, use os.path.abspath to make it
20 # absolute, like shown here.
21 #sys.path.append(os.path.abspath('.'))
22
23 # General configuration
24 # ---------------------
25
26 # Add any Sphinx extension module names here, as strings. They can be extensions
27 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
28 extensions = ['sphinx.ext.autodoc','sphinx.ext.autosummary']
29 # Optional extensions
30 extra_extensions = ['sphinx_rtd_theme']
31 if sphinx.version_info[:2] < (1,3):
32     extra_extensions += ['sphinxcontrib.napoleon']
33 else:
34     extra_extensions += ['sphinx.ext.napoleon']
35 for ext in extra_extensions:
36     try:
37         importlib.import_module(ext)
38         extensions.append(ext)
39         globals().update({'use_{}'.format(ext):True})
40     except:
41         globals().update({'use_{}'.format(ext):False})
42
43 #add pdfbuilder to build a pdf with rst2pdf
44 #extensions = ['rst2pdf.pdfbuilder']
45
46 # Add any paths that contain templates here, relative to this directory.
47 templates_path = [os.path.join('@CMAKE_CURRENT_SOURCE_DIR@','templates')]
48
49 # The suffix of source filenames.
50 source_suffix = '.rst'
51
52 # The encoding of source files.
53 #source_encoding = 'utf-8'
54
55 # The master toctree document.
56 master_doc = 'index'
57
58 # General information about the project.
59 project = 'Mesh'
60
61 # Copyright is shown via custom footer
62 html_show_copyright = False
63
64 # The version info for the project you're documenting, acts as replacement for
65 # |version| and |release|, also used in various other places throughout the
66 # built documents.
67 #
68 # The short X.Y version.
69 version = '@SALOMESMESH_VERSION@'
70 # The full version, including alpha/beta/rc tags.
71 release = '@SALOMESMESH_VERSION@'
72
73 # The language for content autogenerated by Sphinx. Refer to documentation
74 # for a list of supported languages.
75 #language = None
76
77 # There are two options for replacing |today|: either, you set today to some
78 # non-false value, then it is used:
79 #today = ''
80 # Else, today_fmt is used as the format for a strftime call.
81 #today_fmt = '%B %d, %Y'
82
83 # List of documents that shouldn't be included in the build.
84 #unused_docs = []
85
86 # List of directories, relative to source directory, that shouldn't be searched
87 # for source files.
88 exclude_trees = ['.build','ref','images','CVS']
89
90 # A list of glob-style patterns that should be excluded when looking for source
91 # files. They are matched against the source file names relative to the
92 # source directory, using slashes as directory separators on all platforms.
93 exclude_patterns = ['**/CVS']
94
95 # The reST default role (used for this markup: `text`) to use for all documents.
96 #default_role = None
97
98 # If true, '()' will be appended to :func: etc. cross-reference text.
99 #add_function_parentheses = True
100
101 # If true, the current module name will be prepended to all description
102 # unit titles (such as .. function::).
103 #add_module_names = True
104
105 # If true, sectionauthor and moduleauthor directives will be shown in the
106 # output. They are ignored by default.
107 #show_authors = False
108
109 # The name of the Pygments (syntax highlighting) style to use.
110 pygments_style = 'sphinx'
111
112
113 # Options for HTML output
114 # -----------------------
115
116 # The theme to use for HTML and HTML Help pages.  Major themes that come with
117 # Sphinx are currently 'default' and 'sphinxdoc'.
118 if use_sphinx_rtd_theme:
119   html_theme = 'sphinx_rtd_theme'
120 else:
121   html_theme = 'default' if sphinx.version_info[:2] < (1,3) else 'classic'
122
123 themes_options = {}
124 themes_options['classic'] = {
125   'body_max_width':'none',
126   'body_min_width':0,
127 }
128 html_theme_options = themes_options.get(html_theme, {})
129
130 # The name for this set of Sphinx documents.  If None, it defaults to
131 # "<project> v<release> documentation".
132 #html_title = None
133
134 # A shorter title for the navigation bar.  Default is the same as html_title.
135 #html_short_title = None
136
137 # The name of an image file (relative to this directory) to place at the top
138 # of the sidebar.
139 #html_logo = None
140
141 # The name of an image file (within the static path) to use as favicon of the
142 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
143 # pixels large.
144 #html_favicon = None
145
146 # Add any paths that contain custom static files (such as style sheets) here,
147 # relative to this directory. They are copied after the builtin static files,
148 # so a file named "default.css" will overwrite the builtin "default.css".
149 html_static_path = [os.path.join('@CMAKE_CURRENT_BINARY_DIR@','static')]
150
151 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
152 # using the given strftime format.
153 #html_last_updated_fmt = '%b %d, %Y'
154
155 # If true, SmartyPants will be used to convert quotes and dashes to
156 # typographically correct entities.
157 #html_use_smartypants = True
158
159 # Custom sidebar templates, maps document names to template names.
160 html_sidebars = { '**': ['globaltoc.html', 'relations.html', 'sourcelink.html', 'searchbox.html'],}
161
162 # Additional templates that should be rendered to pages, maps page names to
163 # template names.
164 #html_additional_pages = {}
165
166 # If false, no module index is generated.
167 html_use_modindex = True 
168
169 # If false, no index is generated.
170 html_use_index = True
171
172 # If true, the index is split into individual pages for each letter.
173 #html_split_index = False
174
175 # If true, the reST sources are included in the HTML build as _sources/<name>.
176 #html_copy_source = True
177
178 # If true, an OpenSearch description file will be output, and all pages will
179 # contain a <link> tag referring to it.  The value of this option must be the
180 # base URL from which the finished HTML is served.
181 #html_use_opensearch = ''
182
183 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
184 #html_file_suffix = ''
185
186 # Output file base name for HTML help builder.
187 htmlhelp_basename = 'smeshdoc'
188
189
190 # Options for LaTeX output
191 # ------------------------
192
193 # The paper size ('letter' or 'a4').
194 #latex_paper_size = 'a4'
195
196 # The font size ('10pt', '11pt' or '12pt').
197 latex_font_size = '10pt'
198
199 # Grouping the document tree into LaTeX files. List of tuples
200 # (source start file, target name, title, author, document class [howto/manual]).
201 latex_documents = [
202   ('index', 'Smesh.tex', 'SMESH User Documentation', '', 'manual'),
203 ]
204
205 # The name of an image file (relative to this directory) to place at the top of
206 # the title page.
207 #latex_logo = None
208
209 # For "manual" documents, if this is true, then toplevel headings are parts,
210 # not chapters.
211 #latex_use_parts = False
212
213 # Additional stuff for the LaTeX preamble.
214 latex_preamble = """
215 \RecustomVerbatimEnvironment
216  {Verbatim}{Verbatim}
217  {fontsize=\scriptsize}
218 """
219
220 # Documents to append as an appendix to all manuals.
221 #latex_appendices = []
222
223 # If false, no module index is generated.
224 latex_use_modindex = True
225
226 #Options for rst2pdf output (through reportlab)
227 pdf_documents = [
228   ('index', 'Smesh.tex', 'SMESH User Documentation', '', 'manual'),
229 ]
230
231 # A comma-separated list of custom stylesheets.
232 pdf_stylesheets = ['sphinx','kerning','a4']
233
234 # Create a compressed PDF
235 # Use True/False or 1/0
236 #pdf_compressed = False
237
238 # A colon-separated list of folders to search for fonts. Example:
239 # pdf_font_path = ['/usr/share/fonts', '/usr/share/texmf-dist/fonts/']
240
241 # Language to be used for hyphenation support
242 #pdf_language = "en_US"
243
244 # Example configuration for intersphinx: refer to the Python standard library.
245 intersphinx_mapping = {'https://docs.python.org/': None}
246
247 locale_dirs = [os.path.join('@CMAKE_CURRENT_BINARY_DIR@','locale')]   # path is example but recommended.
248 gettext_compact = False     # optional