1 # -*- coding: utf-8 -*-
3 # CMake build procedure documentation build configuration file, created by
4 # sphinx-quickstart on Tue Jul 2 14:10:22 2013.
6 # This file is execfile()d with the current directory set to its containing dir.
8 # Note that not all possible configuration values are present in this
11 # All configuration values have a default; values that are commented out
12 # serve to show the default.
17 # If extensions (or modules to document with autodoc) are in another directory,
18 # add these directories to sys.path here. If the directory is relative to the
19 # documentation root, use os.path.abspath to make it absolute, like shown here.
20 #sys.path.insert(0, os.path.abspath('.'))
22 # -- General configuration -----------------------------------------------------
24 # If your documentation needs a minimal Sphinx version, state it here.
27 # Add any Sphinx extension module names here, as strings. They can be extensions
28 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
31 import sphinx_rtd_theme
32 extensions += ['sphinx_rtd_theme']
37 # Add any paths that contain templates here, relative to this directory.
38 templates_path = ['_templates']
40 # The suffix of source filenames.
41 source_suffix = '.rst'
43 # The encoding of source files.
44 #source_encoding = 'utf-8-sig'
46 # The master toctree document.
49 # General information about the project.
50 project = u'CMake build procedure'
51 copyright = u'2013-2020, Adrien Bruneton (CEA), Anthony Geay (CEA), Nicolas Geimer (EDF), Paul Rascle (EDF)'
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.
59 # The full version, including alpha/beta/rc tags.
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 patterns, relative to source directory, that match files and
73 # directories to ignore when looking for source files.
76 # The reST default role (used for this markup: `text`) to use for all documents.
79 # If true, '()' will be appended to :func: etc. cross-reference text.
80 #add_function_parentheses = True
82 # If true, the current module name will be prepended to all description
83 # unit titles (such as .. function::).
84 #add_module_names = True
86 # If true, sectionauthor and moduleauthor directives will be shown in the
87 # output. They are ignored by default.
90 # The name of the Pygments (syntax highlighting) style to use.
91 pygments_style = 'sphinx'
93 # A list of ignored prefixes for module index sorting.
94 #modindex_common_prefix = []
97 # -- Options for HTML output ---------------------------------------------------
99 # The theme to use for HTML and HTML Help pages. See the documentation for
100 # a list of builtin themes.
102 html_theme = 'sphinx_rtd_theme'
104 html_theme = 'default' if sphinx.version_info[:2] < (1,3) else 'classic'
107 themes_options['classic'] = {
108 'body_max_width':'none',
111 html_theme_options = themes_options.get(html_theme, {})
113 # Theme options are theme-specific and customize the look and feel of a theme
114 # further. For a list of options available for each theme, see the
116 #html_theme_options = {}
118 # Add any paths that contain custom themes here, relative to this directory.
119 #html_theme_path = []
121 # The name for this set of Sphinx documents. If None, it defaults to
122 # "<project> v<release> documentation".
125 # A shorter title for the navigation bar. Default is the same as html_title.
126 #html_short_title = None
128 # The name of an image file (relative to this directory) to place at the top
132 # The name of an image file (within the static path) to use as favicon of the
133 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
137 # Add any paths that contain custom static files (such as style sheets) here,
138 # relative to this directory. They are copied after the builtin static files,
139 # so a file named "default.css" will overwrite the builtin "default.css".
140 html_static_path = ['_static']
142 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
143 # using the given strftime format.
144 #html_last_updated_fmt = '%b %d, %Y'
146 # If true, SmartyPants will be used to convert quotes and dashes to
147 # typographically correct entities.
148 #html_use_smartypants = True
150 # Custom sidebar templates, maps document names to template names.
153 # Additional templates that should be rendered to pages, maps page names to
155 #html_additional_pages = {}
157 # If false, no module index is generated.
158 #html_domain_indices = True
160 # If false, no index is generated.
161 #html_use_index = True
163 # If true, the index is split into individual pages for each letter.
164 #html_split_index = False
166 # If true, links to the reST sources are added to the pages.
167 #html_show_sourcelink = True
169 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
170 #html_show_sphinx = True
172 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
173 #html_show_copyright = True
175 # If true, an OpenSearch description file will be output, and all pages will
176 # contain a <link> tag referring to it. The value of this option must be the
177 # base URL from which the finished HTML is served.
178 #html_use_opensearch = ''
180 # This is the file name suffix for HTML files (e.g. ".xhtml").
181 #html_file_suffix = None
183 # Output file base name for HTML help builder.
184 htmlhelp_basename = 'CMakebuildproceduredoc'
187 # -- Options for LaTeX output --------------------------------------------------
190 # The paper size ('letterpaper' or 'a4paper').
191 #'papersize': 'letterpaper',
193 # The font size ('10pt', '11pt' or '12pt').
194 #'pointsize': '10pt',
196 # Additional stuff for the LaTeX preamble.
200 # Grouping the document tree into LaTeX files. List of tuples
201 # (source start file, target name, title, author, documentclass [howto/manual]).
203 ('index', 'CMakebuildprocedure.tex', u'CMake build procedure Documentation',
204 u'Adrien Bruneton (CEA), Anthony Geay (CEA), Nicolas Geimer (EDF), Paul Rascle (EDF)', 'manual'),
207 # The name of an image file (relative to this directory) to place at the top of
211 # For "manual" documents, if this is true, then toplevel headings are parts,
213 #latex_use_parts = False
215 # If true, show page references after internal links.
216 #latex_show_pagerefs = False
218 # If true, show URL addresses after external links.
219 #latex_show_urls = False
221 # Documents to append as an appendix to all manuals.
222 #latex_appendices = []
224 # If false, no module index is generated.
225 #latex_domain_indices = True
228 # -- Options for manual page output --------------------------------------------
230 # One entry per manual page. List of tuples
231 # (source start file, name, description, authors, manual section).
233 ('index', 'cmakebuildprocedure', u'CMake build procedure Documentation',
234 [u'Adrien Bruneton (CEA), Anthony Geay (CEA), Nicolas Geimer (EDF), Paul Rascle (EDF)'], 1)
237 # If true, show URL addresses after external links.
238 #man_show_urls = False
241 # -- Options for Texinfo output ------------------------------------------------
243 # Grouping the document tree into Texinfo files. List of tuples
244 # (source start file, target name, title, author,
245 # dir menu entry, description, category)
246 texinfo_documents = [
247 ('index', 'CMakebuildprocedure', u'CMake build procedure Documentation',
248 u'Adrien Bruneton (CEA), Anthony Geay (CEA), Nicolas Geimer (EDF), Paul Rascle (EDF)', 'CMakebuildprocedure', 'One line description of project.',
252 # Documents to append as an appendix to all manuals.
253 #texinfo_appendices = []
255 # If false, no module index is generated.
256 #texinfo_domain_indices = True
258 # How to display URL addresses: 'footnote', 'no', or 'inline'.
259 #texinfo_show_urls = 'footnote'