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']
37 templates_path = [os.path.join('@CMAKE_CURRENT_SOURCE_DIR@','templates')]
39 # The suffix of source filenames.
40 source_suffix = '.rst'
42 # The encoding of source files.
43 #source_encoding = 'utf-8'
45 # The master toctree document.
48 # General information about the project.
49 project = u"MEDCoupling User's Guide"
50 copyright = u'2015-2023, Geay, Bruneton'
52 # The version info for the project you're documenting, acts as replacement for
53 # |version| and |release|, also used in various other places throughout the
56 # The short X.Y version.
57 version = '@MEDCOUPLING_VERSION@'
58 # The full version, including alpha/beta/rc tags.
59 release = '@MEDCOUPLING_VERSION@'
61 # The language for content autogenerated by Sphinx. Refer to documentation
62 # for a list of supported languages.
65 # There are two options for replacing |today|: either, you set today to some
66 # non-false value, then it is used:
68 # Else, today_fmt is used as the format for a strftime call.
69 #today_fmt = '%B %d, %Y'
71 # List of documents that shouldn't be included in the build.
74 # List of directories, relative to source directory, that shouldn't be searched
78 # The reST default role (used for this markup: `text`) to use for all documents.
81 # If true, '()' will be appended to :func: etc. cross-reference text.
82 #add_function_parentheses = True
84 # If true, the current module name will be prepended to all description
85 # unit titles (such as .. function::).
86 #add_module_names = True
88 # If true, sectionauthor and moduleauthor directives will be shown in the
89 # output. They are ignored by default.
92 # The name of the Pygments (syntax highlighting) style to use.
93 pygments_style = 'sphinx'
96 # Options for HTML output
97 # -----------------------
99 html_theme = 'sphinx_rtd_theme'
101 html_theme = 'default' if sphinx.version_info[:2] < (1,3) else 'classic'
104 themes_options['classic'] = {
105 'body_max_width':'none',
108 html_theme_options = themes_options.get(html_theme, {})
110 # The style sheet to use for HTML and HTML Help pages. A file of that name
111 # must exist either in Sphinx' static/ path, or in one of the custom paths
112 # given in html_static_path.
113 #html_style = 'default.css'
115 # The name for this set of Sphinx documents. If None, it defaults to
116 # "<project> v<release> documentation".
119 # A shorter title for the navigation bar. Default is the same as html_title.
120 #html_short_title = None
122 # The name of an image file (relative to this directory) to place at the top
126 # The name of an image file (within the static path) to use as favicon of the
127 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
131 # Add any paths that contain custom static files (such as style sheets) here,
132 # relative to this directory. They are copied after the builtin static files,
133 # so a file named "default.css" will overwrite the builtin "default.css".
134 #html_static_path = ['_static']
135 html_static_path = [os.path.join('@CMAKE_CURRENT_BINARY_DIR@','static')]
137 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
138 # using the given strftime format.
139 #html_last_updated_fmt = '%b %d, %Y'
141 # If true, SmartyPants will be used to convert quotes and dashes to
142 # typographically correct entities.
143 #html_use_smartypants = True
145 # Custom sidebar templates, maps document names to template names.
148 # Additional templates that should be rendered to pages, maps page names to
150 #html_additional_pages = {}
152 # If false, no module index is generated.
153 #html_use_modindex = True
155 # If false, no index is generated.
156 #html_use_index = True
158 # If true, the index is split into individual pages for each letter.
159 #html_split_index = False
161 # If true, the reST sources are included in the HTML build as _sources/<name>.
162 #html_copy_source = True
164 # If true, an OpenSearch description file will be output, and all pages will
165 # contain a <link> tag referring to it. The value of this option must be the
166 # base URL from which the finished HTML is served.
167 #html_use_opensearch = ''
169 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
170 #html_file_suffix = ''
172 # Output file base name for HTML help builder.
173 htmlhelp_basename = 'MEDCouplingUsersGuide'
176 # Options for LaTeX output
177 # ------------------------
179 # The paper size ('letter' or 'a4').
180 #latex_paper_size = 'letter'
182 # The font size ('10pt', '11pt' or '12pt').
183 #latex_font_size = '10pt'
185 # Grouping the document tree into LaTeX files. List of tuples
186 # (source start file, target name, title, author, document class [howto/manual]).
188 ('index', 'MEDCouplingUserGuide.tex', "MEDCoupling User's Guide",
189 'A. Geay, A. Bruneton', 'manual'),
192 # The name of an image file (relative to this directory) to place at the top of
196 # For "manual" documents, if this is true, then toplevel headings are parts,
198 #latex_use_parts = False
200 # Additional stuff for the LaTeX preamble.
203 # Documents to append as an appendix to all manuals.
204 #latex_appendices = []
206 # If false, no module index is generated.
207 #latex_use_modindex = True
209 locale_dirs = [os.path.join('@CMAKE_CURRENT_BINARY_DIR@','locale')] # path is example but recommended.
210 gettext_compact = False # optional