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