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