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