1 # -*- coding: utf-8 -*-
3 # yacs documentation build configuration file, created by
4 # sphinx-quickstart on Fri Aug 29 09:57:25 2008.
6 # This file is execfile()d with the current directory set to its containing dir.
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).
11 # All configuration values have a default; values that are commented out
12 # serve to show the default.
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('.'))
22 # General configuration
23 # ---------------------
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']
29 import sphinx_rtd_theme
30 extensions += ['sphinx_rtd_theme']
34 #add pdfbuilder to build a pdf with rst2pdf
35 #extensions = ['rst2pdf.pdfbuilder']
37 # Add any paths that contain templates here, relative to this directory.
38 templates_path = [os.path.join('@CMAKE_CURRENT_SOURCE_DIR@','templates')]
40 # The suffix of source filenames.
41 source_suffix = '.rst'
43 # The encoding of source files.
44 #source_encoding = 'utf-8'
46 # The master toctree document.
49 # General information about the project.
51 copyright = '2012-2021 CEA/DEN, EDF R&D'
53 # Copyright is shown via custom footer
54 html_show_copyright = True
56 # The version info for the project you're documenting, acts as replacement for
57 # |version| and |release|, also used in various other places throughout the
60 # The short X.Y version.
61 version = '@SALOMEGUI_VERSION@'
62 # The full version, including alpha/beta/rc tags.
63 release = '@SALOMEGUI_VERSION@'
65 # The language for content autogenerated by Sphinx. Refer to documentation
66 # for a list of supported languages.
69 # There are two options for replacing |today|: either, you set today to some
70 # non-false value, then it is used:
72 # Else, today_fmt is used as the format for a strftime call.
73 #today_fmt = '%B %d, %Y'
75 # List of documents that shouldn't be included in the build.
78 # List of directories, relative to source directory, that shouldn't be searched
80 exclude_trees = ['.build','ref','images','CVS']
82 # A list of glob-style patterns that should be excluded when looking for source
83 # files. They are matched against the source file names relative to the
84 # source directory, using slashes as directory separators on all platforms.
85 exclude_patterns = ['**/CVS']
87 # The reST default role (used for this markup: `text`) to use for all documents.
90 # If true, '()' will be appended to :func: etc. cross-reference text.
91 #add_function_parentheses = True
93 # If true, the current module name will be prepended to all description
94 # unit titles (such as .. function::).
95 #add_module_names = True
97 # If true, sectionauthor and moduleauthor directives will be shown in the
98 # output. They are ignored by default.
101 # The name of the Pygments (syntax highlighting) style to use.
102 pygments_style = 'sphinx'
105 # Options for HTML output
106 # -----------------------
108 # The theme to use for HTML and HTML Help pages. Major themes that come with
109 # Sphinx are currently 'default' and 'sphinxdoc'.
111 html_theme = 'sphinx_rtd_theme'
113 html_theme = 'default' if sphinx.version_info[:2] < (1,3) else 'classic'
116 themes_options['classic'] = {
117 'body_max_width':'none',
120 html_theme_options = themes_options.get(html_theme, {})
122 # The name for this set of Sphinx documents. If None, it defaults to
123 # "<project> v<release> documentation".
126 # A shorter title for the navigation bar. Default is the same as html_title.
127 #html_short_title = None
129 # The name of an image file (relative to this directory) to place at the top
133 # The name of an image file (within the static path) to use as favicon of the
134 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
138 # Add any paths that contain custom static files (such as style sheets) here,
139 # relative to this directory. They are copied after the builtin static files,
140 # so a file named "default.css" will overwrite the builtin "default.css".
141 html_static_path = [os.path.join('@CMAKE_CURRENT_BINARY_DIR@','static')]
143 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
144 # using the given strftime format.
145 #html_last_updated_fmt = '%b %d, %Y'
147 # If true, SmartyPants will be used to convert quotes and dashes to
148 # typographically correct entities.
149 #html_use_smartypants = True
151 # Custom sidebar templates, maps document names to template names.
152 html_sidebars = { '**': ['globaltoc.html', 'relations.html', 'sourcelink.html', 'searchbox.html'],}
154 # Additional templates that should be rendered to pages, maps page names to
156 #html_additional_pages = {}
158 # If false, no module index is generated.
159 html_use_modindex = True
161 # If false, no index is generated.
162 html_use_index = False
164 # If true, the index is split into individual pages for each letter.
165 #html_split_index = False
167 # If true, the reST sources are included in the HTML build as _sources/<name>.
168 #html_copy_source = True
170 # If true, an OpenSearch description file will be output, and all pages will
171 # contain a <link> tag referring to it. The value of this option must be the
172 # base URL from which the finished HTML is served.
173 #html_use_opensearch = ''
175 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
176 #html_file_suffix = ''
178 # Output file base name for HTML help builder.
179 htmlhelp_basename = 'guidoc'
182 # Options for LaTeX output
183 # ------------------------
185 # The paper size ('letter' or 'a4').
186 latex_paper_size = 'a4'
188 # The font size ('10pt', '11pt' or '12pt').
189 latex_font_size = '10pt'
191 # Grouping the document tree into LaTeX files. List of tuples
192 # (source start file, target name, title, author, document class [howto/manual]).
194 ('index', 'FIELDS.tex', 'Fields User Documentation', '', 'manual'),
197 # The name of an image file (relative to this directory) to place at the top of
201 # For "manual" documents, if this is true, then toplevel headings are parts,
203 #latex_use_parts = False
205 # Additional stuff for the LaTeX preamble.
207 \RecustomVerbatimEnvironment
209 {fontsize=\scriptsize}
212 # Documents to append as an appendix to all manuals.
213 #latex_appendices = []
215 # If false, no module index is generated.
216 latex_use_modindex = True
218 #Options for rst2pdf output (through reportlab)
220 ('index', 'GUI.tex', 'GUI User Documentation', '', 'manual'),
223 # A comma-separated list of custom stylesheets.
224 pdf_stylesheets = ['sphinx','kerning','a4']
226 # Create a compressed PDF
227 # Use True/False or 1/0
228 #pdf_compressed = False
230 # A colon-separated list of folders to search for fonts. Example:
231 # pdf_font_path = ['/usr/share/fonts', '/usr/share/texmf-dist/fonts/']
233 # Language to be used for hyphenation support
234 #pdf_language = "en_US"
236 # Example configuration for intersphinx: refer to the Python standard library.
237 intersphinx_mapping = {'https://docs.python.org/': None}
239 locale_dirs = [os.path.join('@CMAKE_CURRENT_BINARY_DIR@','locale')] # path is example but recommended.
240 gettext_compact = False # optional