]>
Commit | Line | Data |
---|---|---|
2ae078d8 AB |
1 | # -*- coding: utf-8 -*- |
2 | # | |
3 | # Charybdis operator guide documentation build configuration file, created by | |
4 | # sphinx-quickstart on Sat Mar 25 10:41:29 2017. | |
5 | # | |
6 | # This file is execfile()d with the current directory set to its | |
7 | # containing dir. | |
8 | # | |
9 | # Note that not all possible configuration values are present in this | |
10 | # autogenerated file. | |
11 | # | |
12 | # All configuration values have a default; values that are commented out | |
13 | # serve to show the default. | |
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 | # | |
19 | # import os | |
20 | # import sys | |
21 | # sys.path.insert(0, os.path.abspath('.')) | |
22 | ||
23 | # -- General configuration ------------------------------------------------ | |
24 | ||
25 | # If your documentation needs a minimal Sphinx version, state it here. | |
26 | # | |
27 | # needs_sphinx = '1.0' | |
28 | ||
29 | # Add any Sphinx extension module names here, as strings. They can be | |
30 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom | |
31 | # ones. | |
32 | extensions = [] | |
33 | ||
34 | # Add any paths that contain templates here, relative to this directory. | |
35 | templates_path = ['_templates'] | |
36 | ||
37 | # The suffix(es) of source filenames. | |
38 | # You can specify multiple suffix as a list of string: | |
39 | # | |
40 | # source_suffix = ['.rst', '.md'] | |
41 | source_suffix = '.rst' | |
42 | ||
43 | # The encoding of source files. | |
44 | # | |
45 | # source_encoding = 'utf-8-sig' | |
46 | ||
47 | # The master toctree document. | |
48 | master_doc = 'index' | |
49 | ||
50 | # General information about the project. | |
51 | project = u'Charybdis operator guide' | |
8380f40a | 52 | copyright = u'2009, Jilles Tjoelker' |
2ae078d8 AB |
53 | author = u'Jilles Tjoelker' |
54 | ||
55 | # The version info for the project you're documenting, acts as replacement for | |
56 | # |version| and |release|, also used in various other places throughout the | |
57 | # built documents. | |
58 | # | |
59 | # The short X.Y version. | |
60 | version = u'3.5' | |
61 | # The full version, including alpha/beta/rc tags. | |
62 | release = u'3.5' | |
63 | ||
64 | # The language for content autogenerated by Sphinx. Refer to documentation | |
65 | # for a list of supported languages. | |
66 | # | |
67 | # This is also used if you do content translation via gettext catalogs. | |
68 | # Usually you set "language" from the command line for these cases. | |
69 | language = None | |
70 | ||
71 | # There are two options for replacing |today|: either, you set today to some | |
72 | # non-false value, then it is used: | |
73 | # | |
74 | # today = '' | |
75 | # | |
76 | # Else, today_fmt is used as the format for a strftime call. | |
77 | # | |
78 | # today_fmt = '%B %d, %Y' | |
79 | ||
80 | # List of patterns, relative to source directory, that match files and | |
81 | # directories to ignore when looking for source files. | |
82 | # This patterns also effect to html_static_path and html_extra_path | |
83 | exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] | |
84 | ||
85 | # The reST default role (used for this markup: `text`) to use for all | |
86 | # documents. | |
87 | # | |
88 | # default_role = None | |
89 | ||
90 | # If true, '()' will be appended to :func: etc. cross-reference text. | |
91 | # | |
92 | # add_function_parentheses = True | |
93 | ||
94 | # If true, the current module name will be prepended to all description | |
95 | # unit titles (such as .. function::). | |
96 | # | |
97 | # add_module_names = True | |
98 | ||
99 | # If true, sectionauthor and moduleauthor directives will be shown in the | |
100 | # output. They are ignored by default. | |
101 | # | |
102 | # show_authors = False | |
103 | ||
104 | # The name of the Pygments (syntax highlighting) style to use. | |
105 | pygments_style = 'sphinx' | |
106 | ||
107 | # A list of ignored prefixes for module index sorting. | |
108 | # modindex_common_prefix = [] | |
109 | ||
110 | # If true, keep warnings as "system message" paragraphs in the built documents. | |
111 | # keep_warnings = False | |
112 | ||
113 | # If true, `todo` and `todoList` produce output, else they produce nothing. | |
114 | todo_include_todos = False | |
115 | ||
116 | ||
117 | # -- Options for HTML output ---------------------------------------------- | |
118 | ||
119 | # The theme to use for HTML and HTML Help pages. See the documentation for | |
120 | # a list of builtin themes. | |
121 | # | |
3eea7d37 | 122 | #html_theme = 'alabaster' |
2ae078d8 AB |
123 | |
124 | # Theme options are theme-specific and customize the look and feel of a theme | |
125 | # further. For a list of options available for each theme, see the | |
126 | # documentation. | |
127 | # | |
128 | # html_theme_options = {} | |
129 | ||
130 | # Add any paths that contain custom themes here, relative to this directory. | |
131 | # html_theme_path = [] | |
132 | ||
133 | # The name for this set of Sphinx documents. | |
134 | # "<project> v<release> documentation" by default. | |
135 | # | |
136 | # html_title = u'Charybdis operator guide v3.5' | |
137 | ||
138 | # A shorter title for the navigation bar. Default is the same as html_title. | |
139 | # | |
140 | # html_short_title = None | |
141 | ||
142 | # The name of an image file (relative to this directory) to place at the top | |
143 | # of the sidebar. | |
144 | # | |
145 | # html_logo = None | |
146 | ||
147 | # The name of an image file (relative to this directory) to use as a favicon of | |
148 | # the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 | |
149 | # pixels large. | |
150 | # | |
151 | # html_favicon = None | |
152 | ||
153 | # Add any paths that contain custom static files (such as style sheets) here, | |
154 | # relative to this directory. They are copied after the builtin static files, | |
155 | # so a file named "default.css" will overwrite the builtin "default.css". | |
1b81e34a | 156 | # html_static_path = ['_static'] |
2ae078d8 AB |
157 | |
158 | # Add any extra paths that contain custom files (such as robots.txt or | |
159 | # .htaccess) here, relative to this directory. These files are copied | |
160 | # directly to the root of the documentation. | |
161 | # | |
162 | # html_extra_path = [] | |
163 | ||
164 | # If not None, a 'Last updated on:' timestamp is inserted at every page | |
165 | # bottom, using the given strftime format. | |
166 | # The empty string is equivalent to '%b %d, %Y'. | |
167 | # | |
168 | # html_last_updated_fmt = None | |
169 | ||
170 | # If true, SmartyPants will be used to convert quotes and dashes to | |
171 | # typographically correct entities. | |
172 | # | |
173 | # html_use_smartypants = True | |
174 | ||
175 | # Custom sidebar templates, maps document names to template names. | |
176 | # | |
177 | # html_sidebars = {} | |
178 | ||
179 | # Additional templates that should be rendered to pages, maps page names to | |
180 | # template names. | |
181 | # | |
182 | # html_additional_pages = {} | |
183 | ||
184 | # If false, no module index is generated. | |
185 | # | |
186 | # html_domain_indices = True | |
187 | ||
188 | # If false, no index is generated. | |
189 | # | |
190 | # html_use_index = True | |
191 | ||
192 | # If true, the index is split into individual pages for each letter. | |
193 | # | |
194 | # html_split_index = False | |
195 | ||
196 | # If true, links to the reST sources are added to the pages. | |
197 | # | |
198 | # html_show_sourcelink = True | |
199 | ||
200 | # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. | |
201 | # | |
202 | # html_show_sphinx = True | |
203 | ||
204 | # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. | |
205 | # | |
206 | # html_show_copyright = True | |
207 | ||
208 | # If true, an OpenSearch description file will be output, and all pages will | |
209 | # contain a <link> tag referring to it. The value of this option must be the | |
210 | # base URL from which the finished HTML is served. | |
211 | # | |
212 | # html_use_opensearch = '' | |
213 | ||
214 | # This is the file name suffix for HTML files (e.g. ".xhtml"). | |
215 | # html_file_suffix = None | |
216 | ||
217 | # Language to be used for generating the HTML full-text search index. | |
218 | # Sphinx supports the following languages: | |
219 | # 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' | |
220 | # 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr', 'zh' | |
221 | # | |
222 | # html_search_language = 'en' | |
223 | ||
224 | # A dictionary with options for the search language support, empty by default. | |
225 | # 'ja' uses this config value. | |
226 | # 'zh' user can custom change `jieba` dictionary path. | |
227 | # | |
228 | # html_search_options = {'type': 'default'} | |
229 | ||
230 | # The name of a javascript file (relative to the configuration directory) that | |
231 | # implements a search results scorer. If empty, the default will be used. | |
232 | # | |
233 | # html_search_scorer = 'scorer.js' | |
234 | ||
235 | # Output file base name for HTML help builder. | |
236 | htmlhelp_basename = 'Charybdisoperatorguidedoc' | |
237 | ||
238 | # -- Options for LaTeX output --------------------------------------------- | |
239 | ||
240 | latex_elements = { | |
241 | # The paper size ('letterpaper' or 'a4paper'). | |
242 | # | |
243 | # 'papersize': 'letterpaper', | |
244 | ||
245 | # The font size ('10pt', '11pt' or '12pt'). | |
246 | # | |
247 | # 'pointsize': '10pt', | |
248 | ||
249 | # Additional stuff for the LaTeX preamble. | |
250 | # | |
251 | # 'preamble': '', | |
252 | ||
253 | # Latex figure (float) alignment | |
254 | # | |
255 | # 'figure_align': 'htbp', | |
256 | } | |
257 | ||
258 | # Grouping the document tree into LaTeX files. List of tuples | |
259 | # (source start file, target name, title, | |
260 | # author, documentclass [howto, manual, or own class]). | |
261 | latex_documents = [ | |
262 | (master_doc, 'Charybdisoperatorguide.tex', u'Charybdis operator guide Documentation', | |
263 | u'Jilles Tjoelker', 'manual'), | |
264 | ] | |
265 | ||
266 | # The name of an image file (relative to this directory) to place at the top of | |
267 | # the title page. | |
268 | # | |
269 | # latex_logo = None | |
270 | ||
271 | # For "manual" documents, if this is true, then toplevel headings are parts, | |
272 | # not chapters. | |
273 | # | |
274 | # latex_use_parts = False | |
275 | ||
276 | # If true, show page references after internal links. | |
277 | # | |
278 | # latex_show_pagerefs = False | |
279 | ||
280 | # If true, show URL addresses after external links. | |
281 | # | |
282 | # latex_show_urls = False | |
283 | ||
284 | # Documents to append as an appendix to all manuals. | |
285 | # | |
286 | # latex_appendices = [] | |
287 | ||
288 | # It false, will not define \strong, \code, itleref, \crossref ... but only | |
289 | # \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added | |
290 | # packages. | |
291 | # | |
292 | # latex_keep_old_macro_names = True | |
293 | ||
294 | # If false, no module index is generated. | |
295 | # | |
296 | # latex_domain_indices = True | |
297 | ||
298 | ||
299 | # -- Options for manual page output --------------------------------------- | |
300 | ||
301 | # One entry per manual page. List of tuples | |
302 | # (source start file, name, description, authors, manual section). | |
303 | man_pages = [ | |
304 | (master_doc, 'charybdisoperatorguide', u'Charybdis operator guide Documentation', | |
305 | [author], 1) | |
306 | ] | |
307 | ||
308 | # If true, show URL addresses after external links. | |
309 | # | |
310 | # man_show_urls = False | |
311 | ||
312 | ||
313 | # -- Options for Texinfo output ------------------------------------------- | |
314 | ||
315 | # Grouping the document tree into Texinfo files. List of tuples | |
316 | # (source start file, target name, title, author, | |
317 | # dir menu entry, description, category) | |
318 | texinfo_documents = [ | |
319 | (master_doc, 'Charybdisoperatorguide', u'Charybdis operator guide Documentation', | |
320 | author, 'Charybdisoperatorguide', 'One line description of project.', | |
321 | 'Miscellaneous'), | |
322 | ] | |
323 | ||
324 | # Documents to append as an appendix to all manuals. | |
325 | # | |
326 | # texinfo_appendices = [] | |
327 | ||
328 | # If false, no module index is generated. | |
329 | # | |
330 | # texinfo_domain_indices = True | |
331 | ||
332 | # How to display URL addresses: 'footnote', 'no', or 'inline'. | |
333 | # | |
334 | # texinfo_show_urls = 'footnote' | |
335 | ||
336 | # If true, do not generate a @detailmenu in the "Top" node's menu. | |
337 | # | |
338 | # texinfo_no_detailmenu = False | |
339 | ||
340 | ||
341 | # -- Options for Epub output ---------------------------------------------- | |
342 | ||
343 | # Bibliographic Dublin Core info. | |
344 | epub_title = project | |
345 | epub_author = author | |
346 | epub_publisher = author | |
347 | epub_copyright = copyright | |
348 | ||
349 | # The basename for the epub file. It defaults to the project name. | |
350 | # epub_basename = project | |
351 | ||
352 | # The HTML theme for the epub output. Since the default themes are not | |
353 | # optimized for small screen space, using the same theme for HTML and epub | |
354 | # output is usually not wise. This defaults to 'epub', a theme designed to save | |
355 | # visual space. | |
356 | # | |
357 | # epub_theme = 'epub' | |
358 | ||
359 | # The language of the text. It defaults to the language option | |
360 | # or 'en' if the language is not set. | |
361 | # | |
362 | # epub_language = '' | |
363 | ||
364 | # The scheme of the identifier. Typical schemes are ISBN or URL. | |
365 | # epub_scheme = '' | |
366 | ||
367 | # The unique identifier of the text. This can be a ISBN number | |
368 | # or the project homepage. | |
369 | # | |
370 | # epub_identifier = '' | |
371 | ||
372 | # A unique identification for the text. | |
373 | # | |
374 | # epub_uid = '' | |
375 | ||
376 | # A tuple containing the cover image and cover page html template filenames. | |
377 | # | |
378 | # epub_cover = () | |
379 | ||
380 | # A sequence of (type, uri, title) tuples for the guide element of content.opf. | |
381 | # | |
382 | # epub_guide = () | |
383 | ||
384 | # HTML files that should be inserted before the pages created by sphinx. | |
385 | # The format is a list of tuples containing the path and title. | |
386 | # | |
387 | # epub_pre_files = [] | |
388 | ||
389 | # HTML files that should be inserted after the pages created by sphinx. | |
390 | # The format is a list of tuples containing the path and title. | |
391 | # | |
392 | # epub_post_files = [] | |
393 | ||
394 | # A list of files that should not be packed into the epub file. | |
395 | epub_exclude_files = ['search.html'] | |
396 | ||
397 | # The depth of the table of contents in toc.ncx. | |
398 | # | |
399 | # epub_tocdepth = 3 | |
400 | ||
401 | # Allow duplicate toc entries. | |
402 | # | |
403 | # epub_tocdup = True | |
404 | ||
405 | # Choose between 'default' and 'includehidden'. | |
406 | # | |
407 | # epub_tocscope = 'default' | |
408 | ||
409 | # Fix unsupported image types using the Pillow. | |
410 | # | |
411 | # epub_fix_images = False | |
412 | ||
413 | # Scale large images. | |
414 | # | |
415 | # epub_max_image_width = 0 | |
416 | ||
417 | # How to display URL addresses: 'footnote', 'no', or 'inline'. | |
418 | # | |
419 | # epub_show_urls = 'inline' | |
420 | ||
421 | # If false, no index is generated. | |
422 | # | |
423 | # epub_use_index = True |