1 # -*- coding: utf-8 -*-
3 # Copyright (C) 2008-2018 EDF R&D
5 # This file is part of SALOME ADAO module
7 # This library is free software; you can redistribute it and/or
8 # modify it under the terms of the GNU Lesser General Public
9 # License as published by the Free Software Foundation; either
10 # version 2.1 of the License.
12 # This library is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 # Lesser General Public License for more details.
17 # You should have received a copy of the GNU Lesser General Public
18 # License along with this library; if not, write to the Free Software
19 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
23 # Author: Jean-Philippe Argaud, jean-philippe.argaud@edf.fr, EDF R&D
26 # ADAO documentation build configuration file, created by
27 # sphinx-quickstart on Wed Jun 16 15:48:00 2010.
29 # This file is execfile()d with the current directory set to its containing dir.
31 # Note that not all possible configuration values are present in this
34 # All configuration values have a default; values that are commented out
35 # serve to show the default.
39 # If extensions (or modules to document with autodoc) are in another directory,
40 # add these directories to sys.path here. If the directory is relative to the
41 # documentation root, use os.path.abspath to make it absolute, like shown here.
42 #sys.path.append(os.path.abspath('.'))
43 sys.path.append(os.path.abspath("../../bin"))
46 # -- General configuration -----------------------------------------------------
48 # Add any Sphinx extension module names here, as strings. They can be extensions
49 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
50 extensions = ["sphinx.ext.pngmath"]
52 # Add any paths that contain templates here, relative to this directory.
53 templates_path = ['_templates']
55 # The suffix of source filenames.
56 source_suffix = '.rst'
58 # The encoding of source files.
59 source_encoding = 'utf-8'
61 # The master toctree document.
64 # General information about the project.
65 project = u'%s'%module_version.name
66 copyright = u'2008-%s, Jean-Philippe ARGAUD'%module_version.year
68 # The version info for the project you're documenting, acts as replacement for
69 # |version| and |release|, also used in various other places throughout the
72 # The short X.Y version.
74 version = '%s'%module_version.version.replace('_','.')
75 # The full version, including alpha/beta/rc tags.
77 release = '%s'%module_version.version.replace('_','.')
79 # The language for content autogenerated by Sphinx. Refer to documentation
80 # for a list of supported languages.
83 # There are two options for replacing |today|: either, you set today to some
84 # non-false value, then it is used:
86 # Else, today_fmt is used as the format for a strftime call.
87 #today_fmt = '%B %d, %Y'
89 # List of documents that shouldn't be included in the build.
92 # List of directories, relative to source directory, that shouldn't be searched
94 exclude_trees = ['snippets',]
96 # The reST default role (used for this markup: `text`) to use for all documents.
99 # If true, '()' will be appended to :func: etc. cross-reference text.
100 #add_function_parentheses = True
102 # If true, the current module name will be prepended to all description
103 # unit titles (such as .. function::).
104 #add_module_names = True
106 # If true, sectionauthor and moduleauthor directives will be shown in the
107 # output. They are ignored by default.
108 #show_authors = False
110 # The name of the Pygments (syntax highlighting) style to use.
111 pygments_style = 'sphinx'
113 # A list of ignored prefixes for module index sorting.
114 #modindex_common_prefix = []
117 # -- Options for HTML output ---------------------------------------------------
119 # The theme to use for HTML and HTML Help pages. Major themes that come with
120 # Sphinx are currently 'default' and 'sphinxdoc'.
121 html_theme = 'default'
123 # Theme options are theme-specific and customize the look and feel of a theme
124 # further. For a list of options available for each theme, see the
126 #html_theme_options = {}
128 # Add any paths that contain custom themes here, relative to this directory.
129 #html_theme_path = []
131 # The name for this set of Sphinx documents. If None, it defaults to
132 # "<project> v<release> documentation".
133 html_title = "Documentation %s %s"%(module_version.name,module_version.version.replace('_','.'))
135 # A shorter title for the navigation bar. Default is the same as html_title.
136 #html_short_title = None
138 # The name of an image file (relative to this directory) to place at the top
142 # The name of an image file (within the static path) to use as favicon of the
143 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
147 # Add any paths that contain custom static files (such as style sheets) here,
148 # relative to this directory. They are copied after the builtin static files,
149 # so a file named "default.css" will overwrite the builtin "default.css".
150 html_static_path = ['_static']
152 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
153 # using the given strftime format.
154 #html_last_updated_fmt = '%b %d, %Y'
156 # If true, SmartyPants will be used to convert quotes and dashes to
157 # typographically correct entities.
158 #html_use_smartypants = True
160 # Custom sidebar templates, maps document names to template names.
163 # Additional templates that should be rendered to pages, maps page names to
165 #html_additional_pages = {}
167 # If false, no module index is generated.
168 #html_use_modindex = True
170 # If false, no index is generated.
171 #html_use_index = True
173 # If true, the index is split into individual pages for each letter.
174 #html_split_index = False
176 # If true, links to the reST sources are added to the pages.
177 html_show_sourcelink = False
179 # If true, an OpenSearch description file will be output, and all pages will
180 # contain a <link> tag referring to it. The value of this option must be the
181 # base URL from which the finished HTML is served.
182 #html_use_opensearch = ''
184 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
185 #html_file_suffix = ''
187 # Output file base name for HTML help builder.
188 htmlhelp_basename = 'ADAOdoc'
191 # -- Options for LaTeX output --------------------------------------------------
193 # The paper size ('letter' or 'a4').
194 latex_paper_size = 'a4'
196 # The font size ('10pt', '11pt' or '12pt').
197 latex_font_size = '10pt'
199 # Grouping the document tree into LaTeX files. List of tuples
200 # (source start file, target name, title, author, documentclass [howto/manual]).
202 ('index', 'ADAO.tex', u'ADAO documentation',
203 u'Jean-Philippe ARGAUD', 'manual'),
206 # The name of an image file (relative to this directory) to place at the top of
210 # For "manual" documents, if this is true, then toplevel headings are parts,
212 #latex_use_parts = False
214 # Additional stuff for the LaTeX preamble.
217 # Documents to append as an appendix to all manuals.
218 #latex_appendices = []
220 # If false, no module index is generated.
221 #latex_use_modindex = True
223 # -- Options for Epub output ---------------------------------------------------
225 # Bibliographic Dublin Core info.
227 epub_author = u'Jean-Philippe ARGAUD'
228 epub_publisher = u'Jean-Philippe ARGAUD'
229 epub_copyright = copyright
231 # The language of the text. It defaults to the language option
232 # or en if the language is not set.
235 # The scheme of the identifier. Typical schemes are ISBN or URL.
238 # The unique identifier of the text. This can be a ISBN number
239 # or the project homepage.
240 #epub_identifier = ''
242 # A unique identification for the text.
245 # HTML files that should be inserted before the pages created by sphinx.
246 # The format is a list of tuples containing the path and title.
249 # HTML files shat should be inserted after the pages created by sphinx.
250 # The format is a list of tuples containing the path and title.
251 #epub_post_files = []
253 # A list of files that should not be packed into the epub file.
254 #epub_exclude_files = []
256 # The depth of the table of contents in toc.ncx.
259 # Allow duplicate toc entries.
262 # -- Options for PDF output --------------------------------------------------
263 # Grouping the document tree into PDF files. List of tuples
264 # (source start file, target name, title, author, options).
266 # If there is more than one author, separate them with \\.
267 # For example: r'Guido van Rossum\\Fred L. Drake, Jr., editor'
269 # The options element is a dictionary that lets you override
270 # this config per-document.
272 # ('index', u'MyProject', u'My Project', u'Author Name',
273 # dict(pdf_compressed = True))
274 # would mean that specific document would be compressed
275 # regardless of the global pdf_compressed setting.
277 ('contents', u'ADAO', u'ADAO', u'Jean-Philippe ARGAUD', dict(pdf_compressed = True)),
279 # A comma-separated list of custom stylesheets. Example:
280 pdf_stylesheets = ['sphinx','kerning','a4']
281 # Create a compressed PDF
282 # Use True/False or 1/0
283 # Example: compressed=True
284 #pdf_compressed = False
285 pdf_compressed = True
286 # A colon-separated list of folders to search for fonts. Example:
287 # pdf_font_path = ['/usr/share/fonts', '/usr/share/texmf-dist/fonts/']
288 # Language to be used for hyphenation support
289 #pdf_language = "en_US"
290 # Mode for literal blocks wider than the frame. Can be
291 # overflow, shrink or truncate
292 #pdf_fit_mode = "shrink"
293 # Section level that forces a break page.
294 # For example: 1 means top-level sections start in a new page
297 # When a section starts in a new page, force it to be 'even', 'odd',
299 #pdf_breakside = 'any'
300 # Insert footnotes where they are defined instead of
302 #pdf_inline_footnotes = True
303 # verbosity level. 0 1 or 2
305 # If false, no index is generated.
306 #pdf_use_index = True
307 # If false, no modindex is generated.
308 #pdf_use_modindex = True
309 # If false, no coverpage is generated.
310 #pdf_use_coverpage = True
311 # Name of the cover page template to use
312 #pdf_cover_template = 'sphinxcover.tmpl'
313 # Documents to append as an appendix to all manuals.
315 # Enable experimental feature to split table cells. Use it
316 # if you get "DelayedTable too big" errors
317 #pdf_splittables = False
318 # Set the default DPI for images
319 #pdf_default_dpi = 72
320 # Enable rst2pdf extension modules (default is empty list)
321 # you need vectorpdf for better sphinx's graphviz support
322 #pdf_extensions = ['vectorpdf']
323 # Page template name for "regular" pages
324 #pdf_page_template = 'cutePage'