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