1 # -*- coding: utf-8 -*-
3 # Code Coupling and Code Integration documentation build configuration file, created by
4 # sphinx-quickstart on Tue Apr 28 15:28:57 2009.
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.mathjax']
29 import sphinx_rtd_theme
30 extensions += ['sphinx_rtd_theme']
35 # Add any paths that contain templates here, relative to this directory.
36 templates_path = ['_templates']
38 # The suffix of source filenames.
39 source_suffix = '.rst'
41 # The encoding of source files.
42 #source_encoding = 'utf-8'
44 # The master toctree document.
47 # General information about the project.
48 project = u'MEDCoupling tutorial'
49 copyright = u'2015-2022, Geay, Bruneton'
51 # The version info for the project you're documenting, acts as replacement for
52 # |version| and |release|, also used in various other places throughout the
55 # The short X.Y version.
56 version = '@MEDCOUPLING_VERSION@'
57 # The full version, including alpha/beta/rc tags.
58 release = '@MEDCOUPLING_VERSION@'
60 # The language for content autogenerated by Sphinx. Refer to documentation
61 # for a list of supported languages.
64 # There are two options for replacing |today|: either, you set today to some
65 # non-false value, then it is used:
67 # Else, today_fmt is used as the format for a strftime call.
68 #today_fmt = '%B %d, %Y'
70 # List of documents that shouldn't be included in the build.
73 # List of directories, relative to source directory, that shouldn't be searched
77 # The reST default role (used for this markup: `text`) to use for all documents.
80 # If true, '()' will be appended to :func: etc. cross-reference text.
81 #add_function_parentheses = True
83 # If true, the current module name will be prepended to all description
84 # unit titles (such as .. function::).
85 #add_module_names = True
87 # If true, sectionauthor and moduleauthor directives will be shown in the
88 # output. They are ignored by default.
91 # The name of the Pygments (syntax highlighting) style to use.
92 pygments_style = 'sphinx'
95 # Options for HTML output
96 # -----------------------
98 html_theme = 'sphinx_rtd_theme'
100 html_theme = 'default' if sphinx.version_info[:2] < (1,3) else 'classic'
103 themes_options['classic'] = {
104 'body_max_width':'none',
107 html_theme_options = themes_options.get(html_theme, {})
109 # The style sheet to use for HTML and HTML Help pages. A file of that name
110 # must exist either in Sphinx' static/ path, or in one of the custom paths
111 # given in html_static_path.
112 #html_style = 'default.css'
114 # The name for this set of Sphinx documents. If None, it defaults to
115 # "<project> v<release> documentation".
118 # A shorter title for the navigation bar. Default is the same as html_title.
119 #html_short_title = None
121 # The name of an image file (relative to this directory) to place at the top
125 # The name of an image file (within the static path) to use as favicon of the
126 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
130 # Add any paths that contain custom static files (such as style sheets) here,
131 # relative to this directory. They are copied after the builtin static files,
132 # so a file named "default.css" will overwrite the builtin "default.css".
133 #html_static_path = ['_static']
135 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
136 # using the given strftime format.
137 #html_last_updated_fmt = '%b %d, %Y'
139 # If true, SmartyPants will be used to convert quotes and dashes to
140 # typographically correct entities.
141 #html_use_smartypants = True
143 # Custom sidebar templates, maps document names to template names.
146 # Additional templates that should be rendered to pages, maps page names to
148 #html_additional_pages = {}
150 # If false, no module index is generated.
151 #html_use_modindex = True
153 # If false, no index is generated.
154 #html_use_index = True
156 # If true, the index is split into individual pages for each letter.
157 #html_split_index = False
159 # If true, the reST sources are included in the HTML build as _sources/<name>.
160 #html_copy_source = True
162 # If true, an OpenSearch description file will be output, and all pages will
163 # contain a <link> tag referring to it. The value of this option must be the
164 # base URL from which the finished HTML is served.
165 #html_use_opensearch = ''
167 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
168 #html_file_suffix = ''
170 # Output file base name for HTML help builder.
171 htmlhelp_basename = 'MEDCouplingTutorial'
174 # Options for LaTeX output
175 # ------------------------
177 # The paper size ('letter' or 'a4').
178 #latex_paper_size = 'letter'
180 # The font size ('10pt', '11pt' or '12pt').
181 #latex_font_size = '10pt'
183 # Grouping the document tree into LaTeX files. List of tuples
184 # (source start file, target name, title, author, document class [howto/manual]).
186 ('index', 'MEDCouplingTutorial.tex', ur'MEDCoupling tutorial',
187 ur'A. Geay, A. Bruneton', 'manual'),
190 # The name of an image file (relative to this directory) to place at the top of
194 # For "manual" documents, if this is true, then toplevel headings are parts,
196 #latex_use_parts = False
198 # Additional stuff for the LaTeX preamble.
201 # Documents to append as an appendix to all manuals.
202 #latex_appendices = []
204 # If false, no module index is generated.
205 #latex_use_modindex = True