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 = '2007-2022 CEA/DEN, EDF R&D.'
53 # The version info for the project you're documenting, acts as replacement for
54 # |version| and |release|, also used in various other places throughout the
57 # The short X.Y version.
58 version = '@SALOMEYACS_VERSION@'
59 # The full version, including alpha/beta/rc tags.
60 release = '@SALOMEYACS_VERSION@'
62 # The language for content autogenerated by Sphinx. Refer to documentation
63 # for a list of supported languages.
66 # There are two options for replacing |today|: either, you set today to some
67 # non-false value, then it is used:
69 # Else, today_fmt is used as the format for a strftime call.
70 #today_fmt = '%B %d, %Y'
72 # List of documents that shouldn't be included in the build.
75 # List of directories, relative to source directory, that shouldn't be searched
77 exclude_trees = ['.build','ref','images','CVS']
79 # A list of glob-style patterns that should be excluded when looking for source
80 # files. They are matched against the source file names relative to the
81 # source directory, using slashes as directory separators on all platforms.
82 exclude_patterns = ['**/CVS']
84 # The reST default role (used for this markup: `text`) to use for all documents.
87 # If true, '()' will be appended to :func: etc. cross-reference text.
88 #add_function_parentheses = True
90 # If true, the current module name will be prepended to all description
91 # unit titles (such as .. function::).
92 #add_module_names = True
94 # If true, sectionauthor and moduleauthor directives will be shown in the
95 # output. They are ignored by default.
98 # The name of the Pygments (syntax highlighting) style to use.
99 pygments_style = 'sphinx'
102 # Options for HTML output
103 # -----------------------
105 # The theme to use for HTML and HTML Help pages. Major themes that come with
106 # Sphinx are currently 'default' and 'sphinxdoc'.
108 html_theme = 'sphinx_rtd_theme'
110 html_theme = 'default' if sphinx.version_info[:2] < (1,3) else 'classic'
113 themes_options['classic'] = {
114 'body_max_width':'none',
117 html_theme_options = themes_options.get(html_theme, {})
119 # The name for this set of Sphinx documents. If None, it defaults to
120 # "<project> v<release> documentation".
123 # A shorter title for the navigation bar. Default is the same as html_title.
124 #html_short_title = None
126 # The name of an image file (relative to this directory) to place at the top
130 # The name of an image file (within the static path) to use as favicon of the
131 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
135 # Add any paths that contain custom static files (such as style sheets) here,
136 # relative to this directory. They are copied after the builtin static files,
137 # so a file named "default.css" will overwrite the builtin "default.css".
138 html_static_path = [os.path.join('@CMAKE_CURRENT_SOURCE_DIR@','_static')]
140 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
141 # using the given strftime format.
142 #html_last_updated_fmt = '%b %d, %Y'
144 # If true, SmartyPants will be used to convert quotes and dashes to
145 # typographically correct entities.
146 #html_use_smartypants = True
148 # Custom sidebar templates, maps document names to template names.
151 # Additional templates that should be rendered to pages, maps page names to
153 #html_additional_pages = {}
155 # If false, no module index is generated.
156 #html_use_modindex = True
158 # If false, no index is generated.
159 #html_use_index = True
161 # If true, the index is split into individual pages for each letter.
162 #html_split_index = False
164 # If true, the reST sources are included in the HTML build as _sources/<name>.
165 #html_copy_source = True
167 # If true, an OpenSearch description file will be output, and all pages will
168 # contain a <link> tag referring to it. The value of this option must be the
169 # base URL from which the finished HTML is served.
170 #html_use_opensearch = ''
172 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
173 #html_file_suffix = ''
175 # Output file base name for HTML help builder.
176 htmlhelp_basename = 'yacsdoc'
179 # Options for LaTeX output
180 # ------------------------
182 # The paper size ('letter' or 'a4').
183 latex_paper_size = 'a4'
185 # The font size ('10pt', '11pt' or '12pt').
186 latex_font_size = '10pt'
188 # Grouping the document tree into LaTeX files. List of tuples
189 # (source start file, target name, title, author, document class [howto/manual]).
191 ('using', 'using.tex', 'YACS User Documentation', r'C. Caremoli, N. Crouzet, E. Fayolle,\\P. Rascle, A. Ribes, M. Tajchman', 'manual'),
192 ('integration', 'integration.tex', 'YACS Integration Documentation', r'C. Caremoli, N. Crouzet, E. Fayolle,\\P. Rascle, A. Ribes, M. Tajchman', 'manual'),
195 # The name of an image file (relative to this directory) to place at the top of
199 # For "manual" documents, if this is true, then toplevel headings are parts,
201 #latex_use_parts = False
203 # Additional stuff for the LaTeX preamble.
205 \RecustomVerbatimEnvironment
207 {fontsize=\scriptsize}
210 # Documents to append as an appendix to all manuals.
211 #latex_appendices = []
213 # If false, no module index is generated.
214 latex_use_modindex = False
216 #Options for rst2pdf output (through reportlab)
218 ('using', 'using', 'YACS User Documentation', 'C. Caremoli, N. Crouzet, P. Rascle, A. Ribes, E. Fayolle, M. Tajchman'),
219 ('integration', 'integration', 'YACS Integration Documentation', 'C. Caremoli, N. Crouzet, P. Rascle, A. Ribes, E. Fayolle, M. Tajchman'),
222 # A comma-separated list of custom stylesheets.
223 pdf_stylesheets = ['sphinx','kerning','a4']
225 # Create a compressed PDF
226 # Use True/False or 1/0
227 #pdf_compressed = False
229 # A colon-separated list of folders to search for fonts. Example:
230 # pdf_font_path = ['/usr/share/fonts', '/usr/share/texmf-dist/fonts/']
232 # Language to be used for hyphenation support
233 #pdf_language = "en_US"