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