|
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.
|
|
34 | 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 | 40 | master_doc = 'contents'
|
|
54 | 54 |
|
55 | 55 | # The language for content autogenerated by Sphinx. Refer to documentation
|
56 | 56 | # for a list of supported languages.
|
57 |
| -#language = None |
| 57 | +# language = None |
58 | 58 |
|
59 | 59 | # There are two options for replacing |today|: either, you set today to some
|
60 | 60 | # non-false value, then it is used:
|
61 |
| -#today = '' |
| 61 | +# today = '' |
62 | 62 | # Else, today_fmt is used as the format for a strftime call.
|
63 | 63 | today_fmt = '%Y-%m-%d'
|
64 | 64 |
|
|
67 | 67 | exclude_patterns = ['_build']
|
68 | 68 |
|
69 | 69 | # The reST default role (used for this markup: `text`) to use for all documents.
|
70 |
| -#default_role = None |
| 70 | +# default_role = None |
71 | 71 |
|
72 | 72 | # If true, '()' will be appended to :func: etc. cross-reference text.
|
73 |
| -#add_function_parentheses = True |
| 73 | +# add_function_parentheses = True |
74 | 74 |
|
75 | 75 | # If true, the current module name will be prepended to all description
|
76 | 76 | # unit titles (such as .. function::).
|
77 |
| -#add_module_names = True |
| 77 | +# add_module_names = True |
78 | 78 |
|
79 | 79 | # If true, sectionauthor and moduleauthor directives will be shown in the
|
80 | 80 | # output. They are ignored by default.
|
|
86 | 86 | highlight_language = 'swift'
|
87 | 87 |
|
88 | 88 | # A list of ignored prefixes for module index sorting.
|
89 |
| -#modindex_common_prefix = [] |
| 89 | +# modindex_common_prefix = [] |
90 | 90 |
|
91 | 91 |
|
92 | 92 | # -- Options for HTML output ---------------------------------------------------
|
|
112 | 112 |
|
113 | 113 | # The name for this set of Sphinx documents. If None, it defaults to
|
114 | 114 | # "<project> v<release> documentation".
|
115 |
| -#html_title = None |
| 115 | +# html_title = None |
116 | 116 |
|
117 | 117 | # A shorter title for the navigation bar. Default is the same as html_title.
|
118 |
| -#html_short_title = None |
| 118 | +# html_short_title = None |
119 | 119 |
|
120 | 120 | # The name of an image file (relative to this directory) to place at the top
|
121 | 121 | # of the sidebar.
|
122 |
| -#html_logo = None |
| 122 | +# html_logo = None |
123 | 123 |
|
124 | 124 | # The name of an image file (within the static path) to use as favicon of the
|
125 | 125 | # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
|
137 | 137 |
|
138 | 138 | # If true, SmartyPants will be used to convert quotes and dashes to
|
139 | 139 | # typographically correct entities.
|
140 |
| -#html_use_smartypants = True |
| 140 | +# html_use_smartypants = True |
141 | 141 |
|
142 | 142 | # Custom sidebar templates, maps document names to template names.
|
143 |
| -#html_sidebars = {'index': 'indexsidebar.html'} |
| 143 | +# html_sidebars = {'index': 'indexsidebar.html'} |
144 | 144 |
|
145 | 145 | # Additional templates that should be rendered to pages, maps page names to
|
146 | 146 | # template names.
|
147 | 147 | html_additional_pages = {'LangRef': 'archive/LangRef.html'}
|
148 | 148 |
|
149 | 149 | # If false, no module index is generated.
|
150 |
| -#html_domain_indices = True |
| 150 | +# html_domain_indices = True |
151 | 151 |
|
152 | 152 | # If false, no index is generated.
|
153 |
| -#html_use_index = True |
| 153 | +# html_use_index = True |
154 | 154 |
|
155 | 155 | # If true, the index is split into individual pages for each letter.
|
156 |
| -#html_split_index = False |
| 156 | +# html_split_index = False |
157 | 157 |
|
158 | 158 | # If true, links to the reST sources are added to the pages.
|
159 | 159 | html_show_sourcelink = True
|
160 | 160 |
|
161 | 161 | # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
|
162 |
| -#html_show_sphinx = True |
| 162 | +# html_show_sphinx = True |
163 | 163 |
|
164 | 164 | # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
|
165 |
| -#html_show_copyright = True |
| 165 | +# html_show_copyright = True |
166 | 166 |
|
167 | 167 | # If true, an OpenSearch description file will be output, and all pages will
|
168 | 168 | # contain a <link> tag referring to it. The value of this option must be the
|
169 | 169 | # base URL from which the finished HTML is served.
|
170 |
| -#html_use_opensearch = '' |
| 170 | +# html_use_opensearch = '' |
171 | 171 |
|
172 | 172 | # This is the file name suffix for HTML files (e.g. ".xhtml").
|
173 |
| -#html_file_suffix = None |
| 173 | +# html_file_suffix = None |
174 | 174 |
|
175 | 175 | # Output file base name for HTML help builder.
|
176 | 176 | htmlhelp_basename = 'Swiftdoc'
|
|
180 | 180 |
|
181 | 181 | latex_elements = {
|
182 | 182 | # The paper size ('letterpaper' or 'a4paper').
|
183 |
| - #'papersize': 'letterpaper', |
| 183 | + # 'papersize': 'letterpaper', |
184 | 184 |
|
185 | 185 | # The font size ('10pt', '11pt' or '12pt').
|
186 |
| - #'pointsize': '10pt', |
| 186 | + # 'pointsize': '10pt', |
187 | 187 |
|
188 | 188 | # Additional stuff for the LaTeX preamble.
|
189 |
| - #'preamble': '', |
| 189 | + # 'preamble': '', |
190 | 190 | }
|
191 | 191 |
|
192 | 192 | # Grouping the document tree into LaTeX files. List of tuples
|
|
198 | 198 |
|
199 | 199 | # The name of an image file (relative to this directory) to place at the top of
|
200 | 200 | # the title page.
|
201 |
| -#latex_logo = None |
| 201 | +# latex_logo = None |
202 | 202 |
|
203 | 203 | # For "manual" documents, if this is true, then toplevel headings are parts,
|
204 | 204 | # not chapters.
|
205 |
| -#latex_use_parts = False |
| 205 | +# latex_use_parts = False |
206 | 206 |
|
207 | 207 | # If true, show page references after internal links.
|
208 |
| -#latex_show_pagerefs = False |
| 208 | +# latex_show_pagerefs = False |
209 | 209 |
|
210 | 210 | # If true, show URL addresses after external links.
|
211 |
| -#latex_show_urls = False |
| 211 | +# latex_show_urls = False |
212 | 212 |
|
213 | 213 | # Documents to append as an appendix to all manuals.
|
214 |
| -#latex_appendices = [] |
| 214 | +# latex_appendices = [] |
215 | 215 |
|
216 | 216 | # If false, no module index is generated.
|
217 |
| -#latex_domain_indices = True |
| 217 | +# latex_domain_indices = True |
218 | 218 |
|
219 | 219 |
|
220 | 220 | # -- Options for manual page output --------------------------------------------
|
|
227 | 227 | ]
|
228 | 228 |
|
229 | 229 | # If true, show URL addresses after external links.
|
230 |
| -#man_show_urls = False |
| 230 | +# man_show_urls = False |
231 | 231 |
|
232 | 232 |
|
233 | 233 | # -- Options for Texinfo output ------------------------------------------------
|
234 | 234 |
|
235 | 235 | # Grouping the document tree into Texinfo files. List of tuples
|
236 | 236 | # (source start file, target name, title, author,
|
237 |
| -# dir menu entry, description, category) |
| 237 | +# dir menu entry, description, category) |
238 | 238 | texinfo_documents = [
|
239 | 239 | ('contents', 'Swift', u'Swift Documentation',
|
240 | 240 | u'LLVM project', 'Swift', 'One line description of project.',
|
241 | 241 | 'Miscellaneous'),
|
242 | 242 | ]
|
243 | 243 |
|
244 | 244 | # Documents to append as an appendix to all manuals.
|
245 |
| -#texinfo_appendices = [] |
| 245 | +# texinfo_appendices = [] |
246 | 246 |
|
247 | 247 | # If false, no module index is generated.
|
248 |
| -#texinfo_domain_indices = True |
| 248 | +# texinfo_domain_indices = True |
249 | 249 |
|
250 | 250 | # How to display URL addresses: 'footnote', 'no', or 'inline'.
|
251 |
| -#texinfo_show_urls = 'footnote' |
| 251 | +# texinfo_show_urls = 'footnote' |
252 | 252 |
|
253 | 253 |
|
254 | 254 | # FIXME: Define intersphinx configuration.
|
|
0 commit comments