1 # -*- coding: utf-8 -*-
3 # lld documentation build configuration file.
5 # This file is execfile()d with the current directory set to its containing dir.
7 # Note that not all possible configuration values are present in this
10 # All configuration values have a default; values that are commented out
11 # serve to show the default.
15 # If extensions (or modules to document with autodoc) are in another directory,
16 # add these directories to sys.path here. If the directory is relative to the
17 # documentation root, use os.path.abspath to make it absolute, like shown here.
18 #sys.path.insert(0, os.path.abspath('.'))
20 # -- General configuration -----------------------------------------------------
22 # If your documentation needs a minimal Sphinx version, state it here.
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.intersphinx', 'sphinx.ext.todo']
29 # Add any paths that contain templates here, relative to this directory.
30 templates_path = ['_templates']
32 # The suffix of source filenames.
33 source_suffix = '.rst'
35 # The encoding of source files.
36 #source_encoding = 'utf-8-sig'
38 # The master toctree document.
41 # General information about the project.
43 copyright = u'2011-2014, LLVM Project'
45 # The version info for the project you're documenting, acts as replacement for
46 # |version| and |release|, also used in various other places throughout the
49 # The short X.Y version.
51 # The full version, including alpha/beta/rc tags.
54 # The language for content autogenerated by Sphinx. Refer to documentation
55 # for a list of supported languages.
58 # There are two options for replacing |today|: either, you set today to some
59 # non-false value, then it is used:
61 # Else, today_fmt is used as the format for a strftime call.
62 today_fmt = '%Y-%m-%d'
64 # List of patterns, relative to source directory, that match files and
65 # directories to ignore when looking for source files.
66 exclude_patterns = ['_build']
68 # The reST default role (used for this markup: `text`) to use for all documents.
71 # If true, '()' will be appended to :func: etc. cross-reference text.
72 #add_function_parentheses = True
74 # If true, the current module name will be prepended to all description
75 # unit titles (such as .. function::).
76 #add_module_names = True
78 # If true, sectionauthor and moduleauthor directives will be shown in the
79 # output. They are ignored by default.
82 # The name of the Pygments (syntax highlighting) style to use.
83 pygments_style = 'friendly'
85 # A list of ignored prefixes for module index sorting.
86 #modindex_common_prefix = []
89 # -- Options for HTML output ---------------------------------------------------
91 # The theme to use for HTML and HTML Help pages. See the documentation for
92 # a list of builtin themes.
93 html_theme = 'llvm-theme'
95 # Theme options are theme-specific and customize the look and feel of a theme
96 # further. For a list of options available for each theme, see the
98 #html_theme_options = {}
100 # Add any paths that contain custom themes here, relative to this directory.
101 html_theme_path = ["."]
103 # The name for this set of Sphinx documents. If None, it defaults to
104 # "<project> v<release> documentation".
107 # A shorter title for the navigation bar. Default is the same as html_title.
108 #html_short_title = None
110 # The name of an image file (relative to this directory) to place at the top
114 # If given, this must be the name of an image file (path relative to the
115 # configuration directory) that is the favicon of the docs. Modern browsers use
116 # this as icon for tabs, windows and bookmarks. It should be a Windows-style
117 # icon file (.ico), which is 16x16 or 32x32 pixels large. Default: None. The
118 # image file will be copied to the _static directory of the output HTML, but
119 # only if the file does not already exist there.
120 html_favicon = '_static/favicon.ico'
122 # Add any paths that contain custom static files (such as style sheets) here,
123 # relative to this directory. They are copied after the builtin static files,
124 # so a file named "default.css" will overwrite the builtin "default.css".
125 html_static_path = ['_static']
127 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
128 # using the given strftime format.
129 html_last_updated_fmt = '%Y-%m-%d'
131 # If true, SmartyPants will be used to convert quotes and dashes to
132 # typographically correct entities.
133 #html_use_smartypants = True
135 # Custom sidebar templates, maps document names to template names.
136 html_sidebars = {'index': 'indexsidebar.html'}
138 # Additional templates that should be rendered to pages, maps page names to
140 # html_additional_pages = {'index': 'index.html'}
142 # If false, no module index is generated.
143 #html_domain_indices = True
145 # If false, no index is generated.
146 #html_use_index = True
148 # If true, the index is split into individual pages for each letter.
149 #html_split_index = False
151 # If true, links to the reST sources are added to the pages.
152 html_show_sourcelink = True
154 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
155 #html_show_sphinx = True
157 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
158 #html_show_copyright = True
160 # If true, an OpenSearch description file will be output, and all pages will
161 # contain a <link> tag referring to it. The value of this option must be the
162 # base URL from which the finished HTML is served.
163 #html_use_opensearch = ''
165 # This is the file name suffix for HTML files (e.g. ".xhtml").
166 #html_file_suffix = None
168 # Output file base name for HTML help builder.
169 htmlhelp_basename = 'llddoc'
172 # -- Options for LaTeX output --------------------------------------------------
175 # The paper size ('letterpaper' or 'a4paper').
176 #'papersize': 'letterpaper',
178 # The font size ('10pt', '11pt' or '12pt').
179 #'pointsize': '10pt',
181 # Additional stuff for the LaTeX preamble.
185 # Grouping the document tree into LaTeX files. List of tuples
186 # (source start file, target name, title, author, documentclass [howto/manual]).
188 ('contents', 'lld.tex', u'lld Documentation',
189 u'LLVM project', '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 # If true, show page references after internal links.
201 #latex_show_pagerefs = False
203 # If true, show URL addresses after external links.
204 #latex_show_urls = False
206 # Documents to append as an appendix to all manuals.
207 #latex_appendices = []
209 # If false, no module index is generated.
210 #latex_domain_indices = True
213 # -- Options for manual page output --------------------------------------------
215 # One entry per manual page. List of tuples
216 # (source start file, name, description, authors, manual section).
218 ('contents', 'lld', u'lld Documentation',
219 [u'LLVM project'], 1)
222 # If true, show URL addresses after external links.
223 #man_show_urls = False
226 # -- Options for Texinfo output ------------------------------------------------
228 # Grouping the document tree into Texinfo files. List of tuples
229 # (source start file, target name, title, author,
230 # dir menu entry, description, category)
231 texinfo_documents = [
232 ('contents', 'lld', u'lld Documentation',
233 u'LLVM project', 'lld', 'One line description of project.',
237 # Documents to append as an appendix to all manuals.
238 #texinfo_appendices = []
240 # If false, no module index is generated.
241 #texinfo_domain_indices = True
243 # How to display URL addresses: 'footnote', 'no', or 'inline'.
244 #texinfo_show_urls = 'footnote'
247 # FIXME: Define intersphinx configration.
248 intersphinx_mapping = {}
251 # -- Options for extensions ----------------------------------------------------
253 # Enable this if you want TODOs to show up in the generated documentation.
254 todo_include_todos = True