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