Merge branch 'work.sane_pwd' of git://git.kernel.org/pub/scm/linux/kernel/git/viro/vfs
[linux-2.6-block.git] / Documentation / conf.py
CommitLineData
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
15import sys
16import os
d4fe7e14
MCC
17import sphinx
18
19# Get Sphinx version
c46988ae 20major, minor, patch = sphinx.version_info[:3]
d4fe7e14 21
22cba31b
JN
22
23# If extensions (or modules to document with autodoc) are in another directory,
24# add these directories to sys.path here. If the directory is relative to the
25# documentation root, use os.path.abspath to make it absolute, like shown here.
24dcdeb2 26sys.path.insert(0, os.path.abspath('sphinx'))
606b9ac8 27from load_config import loadConfig
22cba31b
JN
28
29# -- General configuration ------------------------------------------------
30
31# If your documentation needs a minimal Sphinx version, state it here.
c46988ae 32needs_sphinx = '1.2'
22cba31b
JN
33
34# Add any Sphinx extension module names here, as strings. They can be
35# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
36# ones.
db6ccf23 37extensions = ['kerneldoc', 'rstFlatTable', 'kernel_include', 'cdomain', 'kfigure']
22cba31b 38
d4fe7e14 39# The name of the math extension changed on Sphinx 1.4
e2a91f4f 40if major == 1 and minor > 3:
d4fe7e14
MCC
41 extensions.append("sphinx.ext.imgmath")
42else:
43 extensions.append("sphinx.ext.pngmath")
22cba31b
JN
44
45# Add any paths that contain templates here, relative to this directory.
46templates_path = ['_templates']
47
48# The suffix(es) of source filenames.
49# You can specify multiple suffix as a list of string:
50# source_suffix = ['.rst', '.md']
51source_suffix = '.rst'
52
53# The encoding of source files.
54#source_encoding = 'utf-8-sig'
55
56# The master toctree document.
57master_doc = 'index'
58
59# General information about the project.
60project = 'The Linux Kernel'
dc36143f 61copyright = 'The kernel development community'
22cba31b
JN
62author = 'The kernel development community'
63
64# The version info for the project you're documenting, acts as replacement for
65# |version| and |release|, also used in various other places throughout the
66# built documents.
67#
c13ce448
JN
68# In a normal build, version and release are are set to KERNELVERSION and
69# KERNELRELEASE, respectively, from the Makefile via Sphinx command line
70# arguments.
71#
72# The following code tries to extract the information by reading the Makefile,
73# when Sphinx is run directly (e.g. by Read the Docs).
74try:
75 makefile_version = None
76 makefile_patchlevel = None
77 for line in open('../Makefile'):
78 key, val = [x.strip() for x in line.split('=', 2)]
79 if key == 'VERSION':
80 makefile_version = val
81 elif key == 'PATCHLEVEL':
82 makefile_patchlevel = val
83 if makefile_version and makefile_patchlevel:
84 break
85except:
86 pass
87finally:
88 if makefile_version and makefile_patchlevel:
89 version = release = makefile_version + '.' + makefile_patchlevel
90 else:
91 sys.stderr.write('Warning: Could not extract kernel version\n')
92 version = release = "unknown version"
22cba31b
JN
93
94# The language for content autogenerated by Sphinx. Refer to documentation
95# for a list of supported languages.
96#
97# This is also used if you do content translation via gettext catalogs.
98# Usually you set "language" from the command line for these cases.
99language = None
100
101# There are two options for replacing |today|: either, you set today to some
102# non-false value, then it is used:
103#today = ''
104# Else, today_fmt is used as the format for a strftime call.
105#today_fmt = '%B %d, %Y'
106
107# List of patterns, relative to source directory, that match files and
108# directories to ignore when looking for source files.
109exclude_patterns = ['output']
110
111# The reST default role (used for this markup: `text`) to use for all
112# documents.
113#default_role = None
114
115# If true, '()' will be appended to :func: etc. cross-reference text.
116#add_function_parentheses = True
117
118# If true, the current module name will be prepended to all description
119# unit titles (such as .. function::).
120#add_module_names = True
121
122# If true, sectionauthor and moduleauthor directives will be shown in the
123# output. They are ignored by default.
124#show_authors = False
125
126# The name of the Pygments (syntax highlighting) style to use.
127pygments_style = 'sphinx'
128
129# A list of ignored prefixes for module index sorting.
130#modindex_common_prefix = []
131
132# If true, keep warnings as "system message" paragraphs in the built documents.
133#keep_warnings = False
134
135# If true, `todo` and `todoList` produce output, else they produce nothing.
136todo_include_todos = False
137
fd5d6669 138primary_domain = 'c'
b459106e 139highlight_language = 'none'
22cba31b
JN
140
141# -- Options for HTML output ----------------------------------------------
142
143# The theme to use for HTML and HTML Help pages. See the documentation for
144# a list of builtin themes.
145
146# The Read the Docs theme is available from
147# - https://github.com/snide/sphinx_rtd_theme
148# - https://pypi.python.org/pypi/sphinx_rtd_theme
149# - python-sphinx-rtd-theme package (on Debian)
150try:
151 import sphinx_rtd_theme
152 html_theme = 'sphinx_rtd_theme'
153 html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
154except ImportError:
155 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')
156
157# Theme options are theme-specific and customize the look and feel of a theme
158# further. For a list of options available for each theme, see the
159# documentation.
160#html_theme_options = {}
161
162# Add any paths that contain custom themes here, relative to this directory.
163#html_theme_path = []
164
165# The name for this set of Sphinx documents. If None, it defaults to
166# "<project> v<release> documentation".
167#html_title = None
168
169# A shorter title for the navigation bar. Default is the same as html_title.
170#html_short_title = None
171
172# The name of an image file (relative to this directory) to place at the top
173# of the sidebar.
174#html_logo = None
175
176# The name of an image file (within the static path) to use as favicon of the
177# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
178# pixels large.
179#html_favicon = None
180
181# Add any paths that contain custom static files (such as style sheets) here,
182# relative to this directory. They are copied after the builtin static files,
183# so a file named "default.css" will overwrite the builtin "default.css".
bc214671
MH
184
185html_static_path = ['sphinx-static']
186
187html_context = {
188 'css_files': [
189 '_static/theme_overrides.css',
190 ],
191}
22cba31b
JN
192
193# Add any extra paths that contain custom files (such as robots.txt or
194# .htaccess) here, relative to this directory. These files are copied
195# directly to the root of the documentation.
196#html_extra_path = []
197
198# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
199# using the given strftime format.
200#html_last_updated_fmt = '%b %d, %Y'
201
202# If true, SmartyPants will be used to convert quotes and dashes to
203# typographically correct entities.
204#html_use_smartypants = True
205
206# Custom sidebar templates, maps document names to template names.
207#html_sidebars = {}
208
209# Additional templates that should be rendered to pages, maps page names to
210# template names.
211#html_additional_pages = {}
212
213# If false, no module index is generated.
214#html_domain_indices = True
215
216# If false, no index is generated.
217#html_use_index = True
218
219# If true, the index is split into individual pages for each letter.
220#html_split_index = False
221
222# If true, links to the reST sources are added to the pages.
223#html_show_sourcelink = True
224
225# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
226#html_show_sphinx = True
227
228# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
229#html_show_copyright = True
230
231# If true, an OpenSearch description file will be output, and all pages will
232# contain a <link> tag referring to it. The value of this option must be the
233# base URL from which the finished HTML is served.
234#html_use_opensearch = ''
235
236# This is the file name suffix for HTML files (e.g. ".xhtml").
237#html_file_suffix = None
238
239# Language to be used for generating the HTML full-text search index.
240# Sphinx supports the following languages:
241# 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja'
242# 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr'
243#html_search_language = 'en'
244
245# A dictionary with options for the search language support, empty by default.
246# Now only 'ja' uses this config value
247#html_search_options = {'type': 'default'}
248
249# The name of a javascript file (relative to the configuration directory) that
250# implements a search results scorer. If empty, the default will be used.
251#html_search_scorer = 'scorer.js'
252
253# Output file base name for HTML help builder.
254htmlhelp_basename = 'TheLinuxKerneldoc'
255
256# -- Options for LaTeX output ---------------------------------------------
257
258latex_elements = {
259# The paper size ('letterpaper' or 'a4paper').
caee5cde 260'papersize': 'a4paper',
22cba31b
JN
261
262# The font size ('10pt', '11pt' or '12pt').
85c21e5c 263'pointsize': '8pt',
22cba31b
JN
264
265# Latex figure (float) alignment
266#'figure_align': 'htbp',
caee5cde 267
a682ec4b
MCC
268# Don't mangle with UTF-8 chars
269'inputenc': '',
270'utf8extra': '',
271
caee5cde
MCC
272# Additional stuff for the LaTeX preamble.
273 'preamble': '''
85c21e5c
MCC
274 % Adjust margins
275 \\usepackage[margin=0.5in, top=1in, bottom=1in]{geometry}
276
caee5cde
MCC
277 % Allow generate some pages in landscape
278 \\usepackage{lscape}
60459774 279
41cff161
MCC
280 % Put notes in color and let them be inside a table
281 \\definecolor{NoteColor}{RGB}{204,255,255}
282 \\definecolor{WarningColor}{RGB}{255,204,204}
283 \\definecolor{AttentionColor}{RGB}{255,255,204}
284 \\definecolor{OtherColor}{RGB}{204,204,204}
ba1377fb 285 \\newlength{\\mynoticelength}
41cff161 286 \\makeatletter\\newenvironment{coloredbox}[1]{%
aa4e37a3
MCC
287 \\setlength{\\fboxrule}{1pt}
288 \\setlength{\\fboxsep}{7pt}
ba1377fb
MCC
289 \\setlength{\\mynoticelength}{\\linewidth}
290 \\addtolength{\\mynoticelength}{-2\\fboxsep}
291 \\addtolength{\\mynoticelength}{-2\\fboxrule}
292 \\begin{lrbox}{\\@tempboxa}\\begin{minipage}{\\mynoticelength}}{\\end{minipage}\\end{lrbox}%
41cff161
MCC
293 \\ifthenelse%
294 {\\equal{\\py@noticetype}{note}}%
295 {\\colorbox{NoteColor}{\\usebox{\\@tempboxa}}}%
296 {%
297 \\ifthenelse%
298 {\\equal{\\py@noticetype}{warning}}%
299 {\\colorbox{WarningColor}{\\usebox{\\@tempboxa}}}%
300 {%
301 \\ifthenelse%
302 {\\equal{\\py@noticetype}{attention}}%
303 {\\colorbox{AttentionColor}{\\usebox{\\@tempboxa}}}%
304 {\\colorbox{OtherColor}{\\usebox{\\@tempboxa}}}%
305 }%
306 }%
60459774
MCC
307 }\\makeatother
308
309 \\makeatletter
41cff161 310 \\renewenvironment{notice}[2]{%
60459774 311 \\def\\py@noticetype{#1}
41cff161
MCC
312 \\begin{coloredbox}{#1}
313 \\bf\\it
60459774
MCC
314 \\par\\strong{#2}
315 \\csname py@noticestart@#1\\endcsname
316 }
317 {
318 \\csname py@noticeend@\\py@noticetype\\endcsname
41cff161 319 \\end{coloredbox}
60459774
MCC
320 }
321 \\makeatother
a682ec4b
MCC
322
323 % Use some font with UTF-8 support with XeLaTeX
324 \\usepackage{fontspec}
325 \\setsansfont{DejaVu Serif}
326 \\setromanfont{DejaVu Sans}
327 \\setmonofont{DejaVu Sans Mono}
328
ca7bfe2c
MCC
329 % To allow adjusting table sizes
330 \\usepackage{adjustbox}
331
caee5cde 332 '''
22cba31b
JN
333}
334
e2a91f4f
MCC
335# Fix reference escape troubles with Sphinx 1.4.x
336if major == 1 and minor > 3:
337 latex_elements['preamble'] += '\\renewcommand*{\\DUrole}[2]{ #2 }\n'
338
22cba31b
JN
339# Grouping the document tree into LaTeX files. List of tuples
340# (source start file, target name, title,
341# author, documentclass [howto, manual, or own class]).
342latex_documents = [
1dc4bbf0
MCC
343 ('doc-guide/index', 'kernel-doc-guide.tex', 'Linux Kernel Documentation Guide',
344 'The kernel development community', 'manual'),
8d26d90b 345 ('admin-guide/index', 'linux-user.tex', 'Linux Kernel User Documentation',
9d85025b 346 'The kernel development community', 'manual'),
22917b99
JC
347 ('core-api/index', 'core-api.tex', 'The kernel core API manual',
348 'The kernel development community', 'manual'),
349 ('driver-api/index', 'driver-api.tex', 'The kernel driver API manual',
350 'The kernel development community', 'manual'),
e2ba5731
MCC
351 ('input/index', 'linux-input.tex', 'The Linux input driver subsystem',
352 'The kernel development community', 'manual'),
3eb6cd68
JN
353 ('kernel-documentation', 'kernel-documentation.tex', 'The Linux Kernel Documentation',
354 'The kernel development community', 'manual'),
0e4f07a6 355 ('process/index', 'development-process.tex', 'Linux Kernel Development Documentation',
f0ddda3e 356 'The kernel development community', 'manual'),
3eb6cd68 357 ('gpu/index', 'gpu.tex', 'Linux GPU Driver Developer\'s Guide',
22cba31b 358 'The kernel development community', 'manual'),
0d1c7d60
MCC
359 ('media/index', 'media.tex', 'Linux Media Subsystem Documentation',
360 'The kernel development community', 'manual'),
22917b99
JC
361 ('security/index', 'security.tex', 'The kernel security subsystem manual',
362 'The kernel development community', 'manual'),
22cba31b
JN
363]
364
365# The name of an image file (relative to this directory) to place at the top of
366# the title page.
367#latex_logo = None
368
369# For "manual" documents, if this is true, then toplevel headings are parts,
370# not chapters.
371#latex_use_parts = False
372
373# If true, show page references after internal links.
374#latex_show_pagerefs = False
375
376# If true, show URL addresses after external links.
377#latex_show_urls = False
378
379# Documents to append as an appendix to all manuals.
380#latex_appendices = []
381
382# If false, no module index is generated.
383#latex_domain_indices = True
384
385
386# -- Options for manual page output ---------------------------------------
387
388# One entry per manual page. List of tuples
389# (source start file, name, description, authors, manual section).
390man_pages = [
391 (master_doc, 'thelinuxkernel', 'The Linux Kernel Documentation',
392 [author], 1)
393]
394
395# If true, show URL addresses after external links.
396#man_show_urls = False
397
398
399# -- Options for Texinfo output -------------------------------------------
400
401# Grouping the document tree into Texinfo files. List of tuples
402# (source start file, target name, title, author,
403# dir menu entry, description, category)
404texinfo_documents = [
405 (master_doc, 'TheLinuxKernel', 'The Linux Kernel Documentation',
406 author, 'TheLinuxKernel', 'One line description of project.',
407 'Miscellaneous'),
408]
409
410# Documents to append as an appendix to all manuals.
411#texinfo_appendices = []
412
413# If false, no module index is generated.
414#texinfo_domain_indices = True
415
416# How to display URL addresses: 'footnote', 'no', or 'inline'.
417#texinfo_show_urls = 'footnote'
418
419# If true, do not generate a @detailmenu in the "Top" node's menu.
420#texinfo_no_detailmenu = False
421
422
423# -- Options for Epub output ----------------------------------------------
424
425# Bibliographic Dublin Core info.
426epub_title = project
427epub_author = author
428epub_publisher = author
429epub_copyright = copyright
430
431# The basename for the epub file. It defaults to the project name.
432#epub_basename = project
433
434# The HTML theme for the epub output. Since the default themes are not
435# optimized for small screen space, using the same theme for HTML and epub
436# output is usually not wise. This defaults to 'epub', a theme designed to save
437# visual space.
438#epub_theme = 'epub'
439
440# The language of the text. It defaults to the language option
441# or 'en' if the language is not set.
442#epub_language = ''
443
444# The scheme of the identifier. Typical schemes are ISBN or URL.
445#epub_scheme = ''
446
447# The unique identifier of the text. This can be a ISBN number
448# or the project homepage.
449#epub_identifier = ''
450
451# A unique identification for the text.
452#epub_uid = ''
453
454# A tuple containing the cover image and cover page html template filenames.
455#epub_cover = ()
456
457# A sequence of (type, uri, title) tuples for the guide element of content.opf.
458#epub_guide = ()
459
460# HTML files that should be inserted before the pages created by sphinx.
461# The format is a list of tuples containing the path and title.
462#epub_pre_files = []
463
464# HTML files that should be inserted after the pages created by sphinx.
465# The format is a list of tuples containing the path and title.
466#epub_post_files = []
467
468# A list of files that should not be packed into the epub file.
469epub_exclude_files = ['search.html']
470
471# The depth of the table of contents in toc.ncx.
472#epub_tocdepth = 3
473
474# Allow duplicate toc entries.
475#epub_tocdup = True
476
477# Choose between 'default' and 'includehidden'.
478#epub_tocscope = 'default'
479
480# Fix unsupported image types using the Pillow.
481#epub_fix_images = False
482
483# Scale large images.
484#epub_max_image_width = 0
485
486# How to display URL addresses: 'footnote', 'no', or 'inline'.
487#epub_show_urls = 'inline'
488
489# If false, no index is generated.
490#epub_use_index = True
491
492#=======
493# rst2pdf
494#
495# Grouping the document tree into PDF files. List of tuples
496# (source start file, target name, title, author, options).
497#
498# See the Sphinx chapter of http://ralsina.me/static/manual.pdf
499#
500# FIXME: Do not add the index file here; the result will be too big. Adding
501# multiple PDF files here actually tries to get the cross-referencing right
502# *between* PDF files.
503pdf_documents = [
520a2477 504 ('kernel-documentation', u'Kernel', u'Kernel', u'J. Random Bozo'),
22cba31b 505]
24dcdeb2
JN
506
507# kernel-doc extension configuration for running Sphinx directly (e.g. by Read
508# the Docs). In a normal build, these are supplied from the Makefile via command
509# line arguments.
510kerneldoc_bin = '../scripts/kernel-doc'
511kerneldoc_srctree = '..'
606b9ac8
MH
512
513# ------------------------------------------------------------------------------
514# Since loadConfig overwrites settings from the global namespace, it has to be
515# the last statement in the conf.py file
516# ------------------------------------------------------------------------------
517loadConfig(globals())