1 # -*- coding: utf-8 -*-
3 # salomeTools documentation build configuration file, created by
4 # sphinx-quickstart on Wed Sep 14 11:55:14 2011.
6 # This file is execfile()d with the current directory set to its containing dir.
8 # Note that not all possible configuration values are present in this
11 # All configuration values have a default; values that are commented out
12 # serve to show the default.
17 # If extensions (or modules to document with autodoc) are in another directory,
18 # add these directories to sys.path here. If the directory is relative to the
19 # documentation root, use os.path.abspath to make it absolute, like shown here.
20 #sys.path.insert(0, os.path.abspath('.'))
22 # -- General configuration -----------------------------------------------------
24 # If your documentation needs a minimal Sphinx version, state it here.
27 # Add any Sphinx extension module names here, as strings. They can be extensions
28 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
29 extensions = ['sphinx.ext.autodoc']
31 # do not use rst_prolog please
32 # https://github.com/sphinx-doc/sphinx/issues/2445
34 # Add any paths that contain templates here, relative to this directory.
35 templates_path = ['_templates']
37 # The suffix of source filenames.
38 source_suffix = '.rst'
40 # The encoding of source files.
41 #source_encoding = 'utf-8-sig'
43 # The master toctree document.
46 # General information about the project.
47 project = u'salomeTools'
48 copyright = u'2010-2018, CEA'
50 # The version info for the project you're documenting, acts as replacement for
51 # |version| and |release|, also used in various other places throughout the
54 # The short X.Y version.
56 # The full version, including alpha/beta/rc tags.
59 # The language for content autogenerated by Sphinx. Refer to documentation
60 # for a list of supported languages.
63 # There are two options for replacing |today|: either, you set today to some
64 # non-false value, then it is used:
66 # Else, today_fmt is used as the format for a strftime call.
67 #today_fmt = '%B %d, %Y'
69 # List of patterns, relative to source directory, that match files and
70 # directories to ignore when looking for source files.
73 # The reST default role (used for this markup: `text`) to use for all documents.
76 # If true, '()' will be appended to :func: etc. cross-reference text.
77 #add_function_parentheses = True
79 # If true, the current module name will be prepended to all description
80 # unit titles (such as .. function::).
81 #add_module_names = True
83 # If true, sectionauthor and moduleauthor directives will be shown in the
84 # output. They are ignored by default.
87 # The name of the Pygments (syntax highlighting) style to use.
88 pygments_style = 'sphinx'
90 # A list of ignored prefixes for module index sorting.
91 #modindex_common_prefix = []
94 # -- Options for HTML output ---------------------------------------------------
96 # The theme to use for HTML and HTML Help pages. See the documentation for
97 # a list of builtin themes.
98 # default sphinxdoc scrolls agogo traditional nature haiku
99 html_theme = 'alabaster'
101 # Theme options are theme-specific and customize the look and feel of a theme
102 # further. For a list of options available for each theme, see the
104 #html_theme_options = {}
106 # Add any paths that contain custom themes here, relative to this directory.
107 html_theme_path = ["../_themes/alabaster", ]
109 # The name for this set of Sphinx documents. If None, it defaults to
110 # "<project> v<release> documentation".
113 # A shorter title for the navigation bar. Default is the same as html_title.
114 #html_short_title = None
116 # The name of an image file (relative to this directory) to place at the top
118 html_logo = "images/sat_v5.0.png"
120 # The name of an image file (within the static path) to use as favicon of the
121 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
125 # Add any paths that contain custom static files (such as style sheets) here,
126 # relative to this directory. They are copied after the builtin static files,
127 # so a file named "default.css" will overwrite the builtin "default.css".
128 #html_static_path = ['_static']
130 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
131 # using the given strftime format.
132 #html_last_updated_fmt = '%b %d, %Y'
134 # If true, SmartyPants will be used to convert quotes and dashes to
135 # typographically correct entities.
136 html_use_smartypants = False
138 # Custom sidebar templates, maps document names to template names.
141 # Additional templates that should be rendered to pages, maps page names to
143 #html_additional_pages = {}
145 # If false, no module index is generated.
146 #html_domain_indices = True
148 # If false, no index is generated.
149 #html_use_index = True
151 # If true, the index is split into individual pages for each letter.
152 #html_split_index = False
154 # If true, links to the reST sources are added to the pages.
155 #html_show_sourcelink = True
157 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
158 #html_show_sphinx = True
160 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
161 #html_show_copyright = True
163 # If true, an OpenSearch description file will be output, and all pages will
164 # contain a <link> tag referring to it. The value of this option must be the
165 # base URL from which the finished HTML is served.
166 #html_use_opensearch = ''
168 # This is the file name suffix for HTML files (e.g. ".xhtml").
169 #html_file_suffix = None
171 # Output file base name for HTML help builder.
172 htmlhelp_basename = 'salomeToolsdoc'
175 # -- Options for LaTeX output --------------------------------------------------
177 # The paper size ('letter' or 'a4').
178 latex_paper_size = 'a4'
180 # The font size ('10pt', '11pt' or '12pt').
181 #latex_font_size = '10pt'
183 # Grouping the document tree into LaTeX files. List of tuples
184 # (source start file, target name, title, author, documentclass [howto/manual]).
186 ('index', 'salomeTools.tex', u'salomeTools Documentation',
190 # The name of an image file (relative to this directory) to place at the top of
194 # For "manual" documents, if this is true, then toplevel headings are parts,
196 #latex_use_parts = False
198 # If true, show page references after internal links.
199 #latex_show_pagerefs = False
201 # If true, show URL addresses after external links.
202 #latex_show_urls = False
204 # Additional stuff for the LaTeX preamble.
207 # Documents to append as an appendix to all manuals.
208 #latex_appendices = []
210 # If false, no module index is generated.
211 #latex_domain_indices = True
214 # -- Options for manual page output --------------------------------------------
216 # One entry per manual page. List of tuples
217 # (source start file, name, description, authors, manual section).
219 ('index', 'salometools', u'salomeTools Documentation',
223 # Append source folder to path in order to enable autodoc
224 sys.path.append(os.path.join('..'))