1 # -*- coding: utf-8 -*-
3 # This file is execfile()d with the current directory set to its containing dir.
5 # The contents of this file are pickled, so don't put values in the namespace
6 # that aren't pickleable (module imports are okay, they're removed automatically).
8 # All configuration values have a default; values that are commented out
9 # serve to show the default.
14 # If your extensions are in another directory, add it here. If the directory
15 # is relative to the documentation root, use os.path.abspath to make it
16 # absolute, like shown here.
17 #sys.path.append(os.path.abspath('.'))
19 # General configuration
20 # ---------------------
22 # Add any Sphinx extension module names here, as strings. They can be extensions
23 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
26 import sphinx_rtd_theme
27 extensions += ['sphinx_rtd_theme']
32 # Add any paths that contain templates here, relative to this directory.
33 templates_path = ['_templates']
35 # The suffix of source filenames.
36 source_suffix = '.rst'
38 # The encoding of source files.
39 #source_encoding = 'utf-8'
41 # The master toctree document.
44 # General information about the project.
45 project = '(name_of_application)'
46 copyright = '2010-2021 CEA/DEN, EDF R&D, OPEN CASCADE, ASTEK INDUSTRIE'
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
52 # The short X.Y version.
53 version = '@SALOME[NAME_OF_APPLICATION]_MAJOR_VERSION@.@SALOME[NAME_OF_APPLICATION]_MINOR_VERSION@'
54 # The full version, including alpha/beta/rc tags.
55 release = '@SALOME[NAME_OF_APPLICATION]_VERSION@'
57 # The language for content autogenerated by Sphinx. Refer to documentation
58 # for a list of supported languages.
61 # There are two options for replacing |today|: either, you set today to some
62 # non-false value, then it is used:
64 # Else, today_fmt is used as the format for a strftime call.
65 #today_fmt = '%B %d, %Y'
67 # List of documents that shouldn't be included in the build.
70 # List of directories, relative to source directory, that shouldn't be searched
72 exclude_trees = ['.build','ref','images','CVS']
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']
79 # The reST default role (used for this markup: `text`) to use for all documents.
82 # If true, '()' will be appended to :func: etc. cross-reference text.
83 #add_function_parentheses = True
85 # If true, the current module name will be prepended to all description
86 # unit titles (such as .. function::).
87 #add_module_names = True
89 # If true, sectionauthor and moduleauthor directives will be shown in the
90 # output. They are ignored by default.
93 # The name of the Pygments (syntax highlighting) style to use.
94 pygments_style = 'sphinx'
97 # Options for HTML output
98 # -----------------------
100 # The theme to use for HTML and HTML Help pages. Major themes that come with
101 # Sphinx are currently 'default' and 'sphinxdoc'.
103 html_theme = 'sphinx_rtd_theme'
105 html_theme = 'default' if sphinx.version_info[:2] < (1,3) else 'classic'
107 # The name for this set of Sphinx documents. If None, it defaults to
108 # "<project> v<release> documentation".
111 # A shorter title for the navigation bar. Default is the same as html_title.
112 #html_short_title = None
114 # The name of an image file (relative to this directory) to place at the top
118 # The name of an image file (within the static path) to use as favicon of the
119 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
123 # Add any paths that contain custom static files (such as style sheets) here,
124 # relative to this directory. They are copied after the builtin static files,
125 # so a file named "default.css" will overwrite the builtin "default.css".
126 html_static_path = ['@SALOME_[NAME_OF_APPLICATION]_PROFILE_INSTALL_DOC_GUI@/_static']
128 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
129 # using the given strftime format.
130 #html_last_updated_fmt = '%b %d, %Y'
132 # If true, SmartyPants will be used to convert quotes and dashes to
133 # typographically correct entities.
134 #html_use_smartypants = True
136 # Custom sidebar templates, maps document names to template names.
139 # Additional templates that should be rendered to pages, maps page names to
141 #html_additional_pages = {}
143 # If false, no module index is generated.
144 html_use_modindex = False
146 # If false, no index is generated.
147 #html_use_index = True
149 # If true, the index is split into individual pages for each letter.
150 #html_split_index = False
152 # If true, the reST sources are included in the HTML build as _sources/<name>.
153 #html_copy_source = True
155 # If true, an OpenSearch description file will be output, and all pages will
156 # contain a <link> tag referring to it. The value of this option must be the
157 # base URL from which the finished HTML is served.
158 #html_use_opensearch = ''
160 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
161 #html_file_suffix = ''
163 # Output file base name for HTML help builder.
164 htmlhelp_basename = '(name_of_application)doc'
167 # Options for LaTeX output
168 # ------------------------
170 # The paper size ('letter' or 'a4').
171 latex_paper_size = 'a4'
173 # The font size ('10pt', '11pt' or '12pt').
174 latex_font_size = '10pt'
176 # Grouping the document tree into LaTeX files. List of tuples
177 # (source start file, target name, title, author, document class [howto/manual]).
179 ('index', '(name_of_application).tex', '[Name_of_Application] User Documentation', 'A. Ribes', 'manual')
182 # The name of an image file (relative to this directory) to place at the top of
186 # For "manual" documents, if this is true, then toplevel headings are parts,
188 #latex_use_parts = False
190 # Additional stuff for the LaTeX preamble.
193 # Documents to append as an appendix to all manuals.
194 #latex_appendices = []
196 # If false, no module index is generated.
197 latex_use_modindex = False