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