1 # -*- coding: utf-8 -*-
3 # HexaBlock documentation build configuration file, created by
4 # sphinx-quickstart on Fri Nov 19 14:09:24 2010.
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('.'))
21 #sys.path.append(os.path.abspath('sphinxext'))
23 # General configuration
24 # ---------------------
26 # Add any Sphinx extension module names here, as strings. They can be extensions
27 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
28 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest']
30 import sphinx_rtd_theme
31 extensions += ['sphinx_rtd_theme']
36 # extensions = ['matplotlib.sphinxext.mathmpl',
37 # 'matplotlib.sphinxext.only_directives',
38 # 'matplotlib.sphinxext.plot_directive',
39 # 'sphinx.ext.autodoc',
40 # 'sphinx.ext.doctest',
41 # 'ipython_console_highlighting',
42 # 'inheritance_diagram',
45 # Add any paths that contain templates here, relative to this directory.
46 templates_path = ['_templates']
48 # The suffix of source filenames.
49 source_suffix = '.rst'
51 # The encoding of source files.
52 #source_encoding = 'utf-8'
54 # The master toctree document.
57 # General information about the project.
58 project = u'HexaBlock'
59 copyright = u'2009-2022 CEA/DEN, EDF R&D'
61 # The version info for the project you're documenting, acts as replacement for
62 # |version| and |release|, also used in various other places throughout the
65 # The short X.Y version.
66 version = '@SALOMEHEXABLOCK_VERSION@'
67 # The full version, including alpha/beta/rc tags.
68 release = '@SALOMEHEXABLOCK_VERSION@'
70 # The language for content autogenerated by Sphinx. Refer to documentation
71 # for a list of supported languages.
74 # There are two options for replacing |today|: either, you set today to some
75 # non-false value, then it is used:
77 # Else, today_fmt is used as the format for a strftime call.
78 #today_fmt = '%B %d, %Y'
80 # List of documents that shouldn't be included in the build.
83 # List of directories, relative to source directory, that shouldn't be searched
87 # A list of glob-style patterns that should be excluded when looking for source
88 # files. They are matched against the source file names relative to the
89 # source directory, using slashes as directory separators on all platforms.
90 exclude_patterns = ['**/CVS']
92 # The reST default role (used for this markup: `text`) to use for all documents.
95 # If true, '()' will be appended to :func: etc. cross-reference text.
96 #add_function_parentheses = True
98 # If true, the current module name will be prepended to all description
99 # unit titles (such as .. function::).
100 #add_module_names = True
102 # If true, sectionauthor and moduleauthor directives will be shown in the
103 # output. They are ignored by default.
104 #show_authors = False
106 # The name of the Pygments (syntax highlighting) style to use.
107 pygments_style = 'sphinx'
110 # Options for HTML output
111 # -----------------------
113 # The theme to use for HTML and HTML Help pages. Major themes that come with
114 # Sphinx are currently 'default' and 'sphinxdoc'.
116 html_theme = 'sphinx_rtd_theme'
118 html_theme = 'default' if sphinx.version_info[:2] < (1,3) else 'classic'
121 themes_options['classic'] = {
122 'body_max_width':'none',
125 html_theme_options = themes_options.get(html_theme, {})
127 # The style sheet to use for HTML and HTML Help pages. A file of that name
128 # must exist either in Sphinx' static/ path, or in one of the custom paths
129 # given in html_static_path.
130 #html_style = 'default.css'
132 # The name for this set of Sphinx documents. If None, it defaults to
133 # "<project> v<release> documentation".
136 # A shorter title for the navigation bar. Default is the same as html_title.
137 #html_short_title = None
139 # The name of an image file (relative to this directory) to place at the top
143 # The name of an image file (within the static path) to use as favicon of the
144 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
148 # Add any paths that contain custom static files (such as style sheets) here,
149 # relative to this directory. They are copied after the builtin static files,
150 # so a file named "default.css" will overwrite the builtin "default.css".
151 html_static_path = ['@CMAKE_CURRENT_SOURCE_DIR@/_static']
153 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
154 # using the given strftime format.
155 #html_last_updated_fmt = '%b %d, %Y'
157 # If true, SmartyPants will be used to convert quotes and dashes to
158 # typographically correct entities.
159 #html_use_smartypants = True
161 # Custom sidebar templates, maps document names to template names.
164 # Additional templates that should be rendered to pages, maps page names to
166 #html_additional_pages = {}
168 # If false, no module index is generated.
169 #html_use_modindex = True
171 # If false, no index is generated.
172 #html_use_index = True
174 # If true, the index is split into individual pages for each letter.
175 #html_split_index = False
177 # If true, the reST sources are included in the HTML build as _sources/<name>.
178 #html_copy_source = True
180 # If true, an OpenSearch description file will be output, and all pages will
181 # contain a <link> tag referring to it. The value of this option must be the
182 # base URL from which the finished HTML is served.
183 #html_use_opensearch = ''
185 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
186 #html_file_suffix = ''
188 # Output file base name for HTML help builder.
189 htmlhelp_basename = 'HexaBlockdoc'
192 # Options for LaTeX output
193 # ------------------------
195 # The paper size ('letter' or 'a4').
196 #latex_paper_size = 'letter'
198 # The font size ('10pt', '11pt' or '12pt').
199 #latex_font_size = '10pt'
201 # Grouping the document tree into LaTeX files. List of tuples
202 # (source start file, target name, title, author, document class [howto/manual]).
204 ('index', 'HexaBlock.tex', 'HexaBlock Documentation',
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 # Additional stuff for the LaTeX preamble.
219 # Documents to append as an appendix to all manuals.
220 #latex_appendices = []
222 # If false, no module index is generated.
223 #latex_use_modindex = True