1 # -*- coding: utf-8 -*-
3 # CMake build procedure documentation build configuration file, created by
4 # sphinx-quickstart on Tue Jul 2 14:10:22 2013.
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.
19 # If extensions (or modules to document with autodoc) are in another directory,
20 # add these directories to sys.path here. If the directory is relative to the
21 # documentation root, use os.path.abspath to make it absolute, like shown here.
22 #sys.path.insert(0, os.path.abspath('.'))
24 # -- General configuration -----------------------------------------------------
26 # If your documentation needs a minimal Sphinx version, state it here.
29 # Add any Sphinx extension module names here, as strings. They can be extensions
30 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
33 import sphinx_rtd_theme
34 extensions += ['sphinx_rtd_theme']
39 # Add any paths that contain templates here, relative to this directory.
40 templates_path = ['_templates']
42 # The suffix of source filenames.
43 source_suffix = '.rst'
45 # The encoding of source files.
46 #source_encoding = 'utf-8-sig'
48 # The master toctree document.
51 # General information about the project.
52 project = u'SALOME documentation'
53 copyright = u'2012-2022 CEA/DEN, EDF R&D, OPEN CASCADE'
54 author = u'OPEN CASCADE'
55 doc_name = 'salome_documentation'
58 # The version info for the project you're documenting, acts as replacement for
59 # |version| and |release|, also used in various other places throughout the
62 # The full version, including alpha/beta/rc tags.
63 release = '@SALOMEDOCUMENTATION_VERSION@'
64 # The short X.Y version.
65 version = list(map(int, re.sub('[A-Za-z]+[0-9]*$', '', release).split('.')))
66 version = version[:2] if len(version) > 2 and version[-1] == 0 else version
67 version = 'Version ' + '.'.join(map(str, version))
69 # The language for content autogenerated by Sphinx. Refer to documentation
70 # for a list of supported languages.
73 # There are two options for replacing |today|: either, you set today to some
74 # non-false value, then it is used:
76 # Else, today_fmt is used as the format for a strftime call.
77 #today_fmt = '%B %d, %Y'
79 # List of patterns, relative to source directory, that match files and
80 # directories to ignore when looking for source files.
83 # The reST default role (used for this markup: `text`) to use for all documents.
86 # If true, '()' will be appended to :func: etc. cross-reference text.
87 #add_function_parentheses = True
89 # If true, the current module name will be prepended to all description
90 # unit titles (such as .. function::).
91 #add_module_names = True
93 # If true, sectionauthor and moduleauthor directives will be shown in the
94 # output. They are ignored by default.
97 # The name of the Pygments (syntax highlighting) style to use.
98 pygments_style = 'sphinx'
100 # A list of ignored prefixes for module index sorting.
101 #modindex_common_prefix = []
103 # -- Options for HTML output ---------------------------------------------------
105 # The theme to use for HTML and HTML Help pages. See the documentation for
106 # a list of builtin themes.
108 html_theme = 'sphinx_rtd_theme'
110 html_theme = 'default' if sphinx.version_info[:2] < (1,3) else 'classic'
112 # Theme options are theme-specific and customize the look and feel of a theme
113 # further. For a list of options available for each theme, see the
115 themes_options = dict(
116 classic = {'body_max_width': 'none',
119 html_theme_options = themes_options.get(html_theme, {})
121 # Add any paths that contain custom themes here, relative to this directory.
122 #html_theme_path = []
124 # The name for this set of Sphinx documents. If None, it defaults to
125 # "<project> v<release> documentation".
126 html_title = 'SALOME v{version} documentation'.format(version=version)
128 # A shorter title for the navigation bar. Default is the same as html_title.
129 #html_short_title = None
131 # The name of an image file (relative to this directory) to place at the top
133 html_logo = '@CMAKE_CURRENT_SOURCE_DIR@/images/logo.png'
135 # The name of an image file (within the static path) to use as favicon of the
136 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
140 # Add any paths that contain custom static files (such as style sheets) here,
141 # relative to this directory. They are copied after the builtin static files,
142 # so a file named "default.css" will overwrite the builtin "default.css".
143 #html_static_path = ['_static']
145 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
146 # using the given strftime format.
147 #html_last_updated_fmt = '%b %d, %Y'
149 # If true, SmartyPants will be used to convert quotes and dashes to
150 # typographically correct entities.
151 #html_use_smartypants = True
153 # Custom sidebar templates, maps document names to template names.
156 # Additional templates that should be rendered to pages, maps page names to
158 #html_additional_pages = {}
160 # If false, no module index is generated.
161 #html_domain_indices = True
163 # If false, no index is generated.
164 #html_use_index = True
166 # If true, the index is split into individual pages for each letter.
167 #html_split_index = False
169 # If true, links to the reST sources are added to the pages.
170 #html_show_sourcelink = True
172 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
173 #html_show_sphinx = True
175 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
176 #html_show_copyright = True
178 # If true, an OpenSearch description file will be output, and all pages will
179 # contain a <link> tag referring to it. The value of this option must be the
180 # base URL from which the finished HTML is served.
181 #html_use_opensearch = ''
183 # This is the file name suffix for HTML files (e.g. ".xhtml").
184 #html_file_suffix = None
186 # Output file base name for HTML help builder.
187 htmlhelp_basename = doc_name
189 # -- Options for LaTeX output --------------------------------------------------
192 # The paper size ('letterpaper' or 'a4paper').
193 #'papersize': 'letterpaper',
195 # The font size ('10pt', '11pt' or '12pt').
196 #'pointsize': '10pt',
198 # Additional stuff for the LaTeX preamble.
202 # Grouping the document tree into LaTeX files. List of tuples
203 # (source start file, target name, title, author, documentclass [howto/manual]).
205 (master_doc, doc_name, doc_title, author, 'manual'),
208 # The name of an image file (relative to this directory) to place at the top of
212 # For "manual" documents, if this is true, then toplevel headings are parts,
214 #latex_use_parts = False
216 # If true, show page references after internal links.
217 #latex_show_pagerefs = False
219 # If true, show URL addresses after external links.
220 #latex_show_urls = False
222 # Documents to append as an appendix to all manuals.
223 #latex_appendices = []
225 # If false, no module index is generated.
226 #latex_domain_indices = True
228 # -- Options for manual page output --------------------------------------------
230 # One entry per manual page. List of tuples
231 # (source start file, name, description, authors, manual section).
233 (master_doc, doc_name, doc_title, author, 1)
236 # If true, show URL addresses after external links.
237 #man_show_urls = False
239 # -- Options for Texinfo output ------------------------------------------------
241 # Grouping the document tree into Texinfo files. List of tuples
242 # (source start file, target name, title, author,
243 # dir menu entry, description, category)
244 texinfo_documents = [
245 (master_doc, doc_name, doc_title, author, 'Miscellaneous'),
248 # Documents to append as an appendix to all manuals.
249 #texinfo_appendices = []
251 # If false, no module index is generated.
252 #texinfo_domain_indices = True
254 # How to display URL addresses: 'footnote', 'no', or 'inline'.
255 #texinfo_show_urls = 'footnote'