0657eb8335da317a2d98781a5ed15b8be201c871
[lldb.git] / lld / docs / conf.py
1 # -*- coding: utf-8 -*-
2 #
3 # lld documentation build configuration file.
4 #
5 # This file is execfile()d with the current directory set to its containing dir.
6 #
7 # Note that not all possible configuration values are present in this
8 # autogenerated file.
9 #
10 # All configuration values have a default; values that are commented out
11 # serve to show the default.
12
13 import sys, os
14
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('.'))
19
20 # -- General configuration -----------------------------------------------------
21
22 # If your documentation needs a minimal Sphinx version, state it here.
23 #needs_sphinx = '1.0'
24
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']
28
29 # Add any paths that contain templates here, relative to this directory.
30 templates_path = ['_templates']
31
32 # The suffix of source filenames.
33 source_suffix = '.rst'
34
35 # The encoding of source files.
36 #source_encoding = 'utf-8-sig'
37
38 # The master toctree document.
39 master_doc = 'index'
40
41 # General information about the project.
42 project = u'lld'
43 copyright = u'2012, LLVM Project'
44
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
47 # built documents.
48 #
49 # The short X.Y version.
50 version = '3.2'
51 # The full version, including alpha/beta/rc tags.
52 release = '3.2'
53
54 # The language for content autogenerated by Sphinx. Refer to documentation
55 # for a list of supported languages.
56 #language = None
57
58 # There are two options for replacing |today|: either, you set today to some
59 # non-false value, then it is used:
60 #today = ''
61 # Else, today_fmt is used as the format for a strftime call.
62 today_fmt = '%Y-%m-%d'
63
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']
67
68 # The reST default role (used for this markup: `text`) to use for all documents.
69 #default_role = None
70
71 # If true, '()' will be appended to :func: etc. cross-reference text.
72 #add_function_parentheses = True
73
74 # If true, the current module name will be prepended to all description
75 # unit titles (such as .. function::).
76 #add_module_names = True
77
78 # If true, sectionauthor and moduleauthor directives will be shown in the
79 # output. They are ignored by default.
80 show_authors = True
81
82 # The name of the Pygments (syntax highlighting) style to use.
83 pygments_style = 'friendly'
84
85 # A list of ignored prefixes for module index sorting.
86 #modindex_common_prefix = []
87
88
89 # -- Options for HTML output ---------------------------------------------------
90
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'
94
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
97 # documentation.
98 #html_theme_options = {}
99
100 # Add any paths that contain custom themes here, relative to this directory.
101 html_theme_path = ["."]
102
103 # The name for this set of Sphinx documents.  If None, it defaults to
104 # "<project> v<release> documentation".
105 #html_title = None
106
107 # A shorter title for the navigation bar.  Default is the same as html_title.
108 #html_short_title = None
109
110 # The name of an image file (relative to this directory) to place at the top
111 # of the sidebar.
112 #html_logo = None
113
114 # The name of an image file (within the static path) to use as favicon of the
115 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
116 # pixels large.
117 html_favicon = 'favicon.ico'
118
119 # Add any paths that contain custom static files (such as style sheets) here,
120 # relative to this directory. They are copied after the builtin static files,
121 # so a file named "default.css" will overwrite the builtin "default.css".
122 html_static_path = ['_static']
123
124 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
125 # using the given strftime format.
126 html_last_updated_fmt = '%Y-%m-%d'
127
128 # If true, SmartyPants will be used to convert quotes and dashes to
129 # typographically correct entities.
130 #html_use_smartypants = True
131
132 # Custom sidebar templates, maps document names to template names.
133 html_sidebars = {'index': 'indexsidebar.html'}
134
135 # Additional templates that should be rendered to pages, maps page names to
136 # template names.
137 # html_additional_pages = {'index': 'index.html'}
138
139 # If false, no module index is generated.
140 #html_domain_indices = True
141
142 # If false, no index is generated.
143 #html_use_index = True
144
145 # If true, the index is split into individual pages for each letter.
146 #html_split_index = False
147
148 # If true, links to the reST sources are added to the pages.
149 html_show_sourcelink = True
150
151 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
152 #html_show_sphinx = True
153
154 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
155 #html_show_copyright = True
156
157 # If true, an OpenSearch description file will be output, and all pages will
158 # contain a <link> tag referring to it.  The value of this option must be the
159 # base URL from which the finished HTML is served.
160 #html_use_opensearch = ''
161
162 # This is the file name suffix for HTML files (e.g. ".xhtml").
163 #html_file_suffix = None
164
165 # Output file base name for HTML help builder.
166 htmlhelp_basename = 'llddoc'
167
168
169 # -- Options for LaTeX output --------------------------------------------------
170
171 latex_elements = {
172 # The paper size ('letterpaper' or 'a4paper').
173 #'papersize': 'letterpaper',
174
175 # The font size ('10pt', '11pt' or '12pt').
176 #'pointsize': '10pt',
177
178 # Additional stuff for the LaTeX preamble.
179 #'preamble': '',
180 }
181
182 # Grouping the document tree into LaTeX files. List of tuples
183 # (source start file, target name, title, author, documentclass [howto/manual]).
184 latex_documents = [
185   ('contents', 'lld.tex', u'lld Documentation',
186    u'LLVM project', 'manual'),
187 ]
188
189 # The name of an image file (relative to this directory) to place at the top of
190 # the title page.
191 #latex_logo = None
192
193 # For "manual" documents, if this is true, then toplevel headings are parts,
194 # not chapters.
195 #latex_use_parts = False
196
197 # If true, show page references after internal links.
198 #latex_show_pagerefs = False
199
200 # If true, show URL addresses after external links.
201 #latex_show_urls = False
202
203 # Documents to append as an appendix to all manuals.
204 #latex_appendices = []
205
206 # If false, no module index is generated.
207 #latex_domain_indices = True
208
209
210 # -- Options for manual page output --------------------------------------------
211
212 # One entry per manual page. List of tuples
213 # (source start file, name, description, authors, manual section).
214 man_pages = [
215     ('contents', 'lld', u'lld Documentation',
216      [u'LLVM project'], 1)
217 ]
218
219 # If true, show URL addresses after external links.
220 #man_show_urls = False
221
222
223 # -- Options for Texinfo output ------------------------------------------------
224
225 # Grouping the document tree into Texinfo files. List of tuples
226 # (source start file, target name, title, author,
227 #  dir menu entry, description, category)
228 texinfo_documents = [
229   ('contents', 'lld', u'lld Documentation',
230    u'LLVM project', 'lld', 'One line description of project.',
231    'Miscellaneous'),
232 ]
233
234 # Documents to append as an appendix to all manuals.
235 #texinfo_appendices = []
236
237 # If false, no module index is generated.
238 #texinfo_domain_indices = True
239
240 # How to display URL addresses: 'footnote', 'no', or 'inline'.
241 #texinfo_show_urls = 'footnote'
242
243
244 # FIXME: Define intersphinx configration.
245 intersphinx_mapping = {}
246
247
248 # -- Options for extensions ----------------------------------------------------
249
250 # Enable this if you want TODOs to show up in the generated documentation.
251 todo_include_todos = True