blob: 5830b01c56429d38f18e12778ebce543605b3296 [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
Mauro Carvalho Chehabd4fe7e12016-08-16 13:25:43 -030017import sphinx
Akira Yokosawa6b0d3e72022-08-27 13:37:18 +090018import shutil
19
20# helper
21# ------
22
23def have_command(cmd):
24 """Search ``cmd`` in the ``PATH`` environment.
25
26 If found, return True.
27 If not found, return False.
28 """
29 return shutil.which(cmd) is not None
Mauro Carvalho Chehabd4fe7e12016-08-16 13:25:43 -030030
31# Get Sphinx version
Rémy Léonec46988a2017-03-20 16:37:49 +010032major, minor, patch = sphinx.version_info[:3]
Mauro Carvalho Chehabd4fe7e12016-08-16 13:25:43 -030033
Jonathan Corbet31abfdd2023-01-04 13:59:16 -070034#
35# Warn about older versions that we don't want to support for much
36# longer.
37#
38if (major < 2) or (major == 2 and minor < 4):
39 print('WARNING: support for Sphinx < 2.4 will be removed soon.')
Jani Nikula22cba312016-05-19 15:14:05 +030040
41# If extensions (or modules to document with autodoc) are in another directory,
42# add these directories to sys.path here. If the directory is relative to the
43# documentation root, use os.path.abspath to make it absolute, like shown here.
Jani Nikula24dcdeb2016-05-20 11:51:47 +030044sys.path.insert(0, os.path.abspath('sphinx'))
Markus Heiser606b9ac2016-08-13 16:12:42 +020045from load_config import loadConfig
Jani Nikula22cba312016-05-19 15:14:05 +030046
47# -- General configuration ------------------------------------------------
48
49# If your documentation needs a minimal Sphinx version, state it here.
Jonathan Corbet3e893e12023-12-08 16:10:17 -070050needs_sphinx = '2.4.4'
Jani Nikula22cba312016-05-19 15:14:05 +030051
52# Add any Sphinx extension module names here, as strings. They can be
53# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
54# ones.
Jonathan Corbetafde7062020-09-04 10:13:45 -060055extensions = ['kerneldoc', 'rstFlatTable', 'kernel_include',
Kees Cookaa204852019-10-01 11:25:32 -070056 'kfigure', 'sphinx.ext.ifconfig', 'automarkup',
Mauro Carvalho Chehaba7ee04b2020-10-30 08:40:36 +010057 'maintainers_include', 'sphinx.ext.autosectionlabel',
Vegard Nossum7418ec52023-12-15 13:37:01 +010058 'kernel_abi', 'kernel_feat', 'translations']
Jani Nikula22cba312016-05-19 15:14:05 +030059
Jonathan Corbetafde7062020-09-04 10:13:45 -060060if major >= 3:
Mauro Carvalho Chehabd29f34c2020-10-27 10:51:06 +010061 if (major > 3) or (minor > 0 or patch >= 2):
Mauro Carvalho Chehabb34b86d2020-09-28 09:42:44 +020062 # Sphinx c function parser is more pedantic with regards to type
63 # checking. Due to that, having macros at c:function cause problems.
64 # Those needed to be scaped by using c_id_attributes[] array
65 c_id_attributes = [
66 # GCC Compiler types not parsed by Sphinx:
67 "__restrict__",
68
69 # include/linux/compiler_types.h:
70 "__iomem",
71 "__kernel",
72 "noinstr",
73 "notrace",
74 "__percpu",
75 "__rcu",
76 "__user",
James Seo34d9f622023-05-09 10:55:43 -070077 "__force",
Mauro Carvalho Chehabb34b86d2020-09-28 09:42:44 +020078
79 # include/linux/compiler_attributes.h:
80 "__alias",
81 "__aligned",
82 "__aligned_largest",
83 "__always_inline",
84 "__assume_aligned",
85 "__cold",
86 "__attribute_const__",
87 "__copy",
88 "__pure",
89 "__designated_init",
90 "__visible",
91 "__printf",
92 "__scanf",
93 "__gnu_inline",
94 "__malloc",
95 "__mode",
96 "__no_caller_saved_registers",
97 "__noclone",
98 "__nonstring",
99 "__noreturn",
100 "__packed",
101 "__pure",
102 "__section",
103 "__always_unused",
104 "__maybe_unused",
105 "__used",
106 "__weak",
107 "noinline",
Menglong Dong5479d6d2022-08-27 00:01:50 +0800108 "__fix_address",
Kees Cookeeddfa52023-12-14 16:13:54 -0800109 "__counted_by",
Mauro Carvalho Chehabb34b86d2020-09-28 09:42:44 +0200110
111 # include/linux/memblock.h:
112 "__init_memblock",
113 "__meminit",
114
115 # include/linux/init.h:
116 "__init",
117 "__ref",
118
119 # include/linux/linkage.h:
120 "asmlinkage",
David Vernet98e6ab72023-02-01 11:30:14 -0600121
122 # include/linux/btf.h
123 "__bpf_kfunc",
Mauro Carvalho Chehabb34b86d2020-09-28 09:42:44 +0200124 ]
125
Jonathan Corbetafde7062020-09-04 10:13:45 -0600126else:
127 extensions.append('cdomain')
128
Mauro Carvalho Chehab4658b0e2020-03-20 16:11:03 +0100129# Ensure that autosectionlabel will produce unique names
130autosectionlabel_prefix_document = True
131autosectionlabel_maxdepth = 2
132
Akira Yokosawa6b0d3e72022-08-27 13:37:18 +0900133# Load math renderer:
134# For html builder, load imgmath only when its dependencies are met.
135# mathjax is the default math renderer since Sphinx 1.8.
136have_latex = have_command('latex')
137have_dvipng = have_command('dvipng')
Akira Yokosawa3b384e92022-08-27 13:38:17 +0900138load_imgmath = have_latex and have_dvipng
139
140# Respect SPHINX_IMGMATH (for html docs only)
141if 'SPHINX_IMGMATH' in os.environ:
142 env_sphinx_imgmath = os.environ['SPHINX_IMGMATH']
143 if 'yes' in env_sphinx_imgmath:
144 load_imgmath = True
145 elif 'no' in env_sphinx_imgmath:
146 load_imgmath = False
147 else:
148 sys.stderr.write("Unknown env SPHINX_IMGMATH=%s ignored.\n" % env_sphinx_imgmath)
149
150# Always load imgmath for Sphinx <1.8 or for epub docs
151load_imgmath = (load_imgmath or (major == 1 and minor < 8)
Akira Yokosawa6b0d3e72022-08-27 13:37:18 +0900152 or 'epub' in sys.argv)
153
154if load_imgmath:
155 extensions.append("sphinx.ext.imgmath")
156 math_renderer = 'imgmath'
157else:
158 math_renderer = 'mathjax'
Jani Nikula22cba312016-05-19 15:14:05 +0300159
160# Add any paths that contain templates here, relative to this directory.
Jonathan Corbetc404f5d2023-01-19 17:03:05 -0700161templates_path = ['sphinx/templates']
Jani Nikula22cba312016-05-19 15:14:05 +0300162
163# The suffix(es) of source filenames.
164# You can specify multiple suffix as a list of string:
165# source_suffix = ['.rst', '.md']
166source_suffix = '.rst'
167
168# The encoding of source files.
169#source_encoding = 'utf-8-sig'
170
171# The master toctree document.
172master_doc = 'index'
173
174# General information about the project.
175project = 'The Linux Kernel'
Jonathan Corbetdc361432017-02-06 11:52:19 -0700176copyright = 'The kernel development community'
Jani Nikula22cba312016-05-19 15:14:05 +0300177author = 'The kernel development community'
178
179# The version info for the project you're documenting, acts as replacement for
180# |version| and |release|, also used in various other places throughout the
181# built documents.
182#
Jani Nikulac13ce442016-05-28 15:25:41 +0300183# In a normal build, version and release are are set to KERNELVERSION and
184# KERNELRELEASE, respectively, from the Makefile via Sphinx command line
185# arguments.
186#
187# The following code tries to extract the information by reading the Makefile,
188# when Sphinx is run directly (e.g. by Read the Docs).
189try:
190 makefile_version = None
191 makefile_patchlevel = None
192 for line in open('../Makefile'):
193 key, val = [x.strip() for x in line.split('=', 2)]
194 if key == 'VERSION':
195 makefile_version = val
196 elif key == 'PATCHLEVEL':
197 makefile_patchlevel = val
198 if makefile_version and makefile_patchlevel:
199 break
200except:
201 pass
202finally:
203 if makefile_version and makefile_patchlevel:
204 version = release = makefile_version + '.' + makefile_patchlevel
205 else:
Jani Nikulac13ce442016-05-28 15:25:41 +0300206 version = release = "unknown version"
Jani Nikula22cba312016-05-19 15:14:05 +0300207
Jonathan Corbetd5389d32022-09-23 16:28:57 -0600208#
209# HACK: there seems to be no easy way for us to get at the version and
210# release information passed in from the makefile...so go pawing through the
211# command-line options and find it for ourselves.
212#
213def get_cline_version():
214 c_version = c_release = ''
215 for arg in sys.argv:
216 if arg.startswith('version='):
217 c_version = arg[8:]
218 elif arg.startswith('release='):
219 c_release = arg[8:]
220 if c_version:
221 if c_release:
222 return c_version + '-' + c_release
223 return c_version
224 return version # Whatever we came up with before
225
Jani Nikula22cba312016-05-19 15:14:05 +0300226# The language for content autogenerated by Sphinx. Refer to documentation
227# for a list of supported languages.
228#
229# This is also used if you do content translation via gettext catalogs.
230# Usually you set "language" from the command line for these cases.
Akira Yokosawa627f01e2022-06-01 23:34:06 +0900231language = 'en'
Jani Nikula22cba312016-05-19 15:14:05 +0300232
233# There are two options for replacing |today|: either, you set today to some
234# non-false value, then it is used:
235#today = ''
236# Else, today_fmt is used as the format for a strftime call.
237#today_fmt = '%B %d, %Y'
238
239# List of patterns, relative to source directory, that match files and
240# directories to ignore when looking for source files.
241exclude_patterns = ['output']
242
243# The reST default role (used for this markup: `text`) to use for all
244# documents.
245#default_role = None
246
247# If true, '()' will be appended to :func: etc. cross-reference text.
248#add_function_parentheses = True
249
250# If true, the current module name will be prepended to all description
251# unit titles (such as .. function::).
252#add_module_names = True
253
254# If true, sectionauthor and moduleauthor directives will be shown in the
255# output. They are ignored by default.
256#show_authors = False
257
258# The name of the Pygments (syntax highlighting) style to use.
259pygments_style = 'sphinx'
260
261# A list of ignored prefixes for module index sorting.
262#modindex_common_prefix = []
263
264# If true, keep warnings as "system message" paragraphs in the built documents.
265#keep_warnings = False
266
267# If true, `todo` and `todoList` produce output, else they produce nothing.
268todo_include_todos = False
269
John Keepingfd5d6662017-03-03 12:24:05 +0000270primary_domain = 'c'
Jani Nikulab4591062016-11-03 10:26:54 +0200271highlight_language = 'none'
Jani Nikula22cba312016-05-19 15:14:05 +0300272
273# -- Options for HTML output ----------------------------------------------
274
275# The theme to use for HTML and HTML Help pages. See the documentation for
276# a list of builtin themes.
277
Mauro Carvalho Chehabfca72162021-12-07 10:52:59 +0100278# Default theme
Jonathan Corbetd5389d32022-09-23 16:28:57 -0600279html_theme = 'alabaster'
Mauro Carvalho Chehab135707d2021-12-07 10:53:00 +0100280html_css_files = []
Mauro Carvalho Chehabfca72162021-12-07 10:52:59 +0100281
282if "DOCS_THEME" in os.environ:
283 html_theme = os.environ["DOCS_THEME"]
284
Mauro Carvalho Chehaba6fb8b52021-12-07 10:53:02 +0100285if html_theme == 'sphinx_rtd_theme' or html_theme == 'sphinx_rtd_dark_mode':
Mauro Carvalho Chehabfca72162021-12-07 10:52:59 +0100286 # Read the Docs theme
287 try:
288 import sphinx_rtd_theme
289 html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
290
291 # Add any paths that contain custom static files (such as style sheets) here,
292 # relative to this directory. They are copied after the builtin static files,
293 # so a file named "default.css" will overwrite the builtin "default.css".
294 html_css_files = [
295 'theme_overrides.css',
296 ]
Mauro Carvalho Chehaba6fb8b52021-12-07 10:53:02 +0100297
298 # Read the Docs dark mode override theme
299 if html_theme == 'sphinx_rtd_dark_mode':
300 try:
301 import sphinx_rtd_dark_mode
302 extensions.append('sphinx_rtd_dark_mode')
303 except ImportError:
304 html_theme == 'sphinx_rtd_theme'
305
306 if html_theme == 'sphinx_rtd_theme':
307 # Add color-specific RTD normal mode
308 html_css_files.append('theme_rtd_colors.css')
309
Daniel Vettere17f2262022-11-08 12:57:07 +0100310 html_theme_options = {
311 'navigation_depth': -1,
312 }
313
Mauro Carvalho Chehabfca72162021-12-07 10:52:59 +0100314 except ImportError:
Jonathan Corbet02d33e82022-10-11 11:25:25 -0600315 html_theme = 'alabaster'
Mauro Carvalho Chehabfca72162021-12-07 10:52:59 +0100316
Mauro Carvalho Chehab135707d2021-12-07 10:53:00 +0100317if "DOCS_CSS" in os.environ:
318 css = os.environ["DOCS_CSS"].split(" ")
319
320 for l in css:
321 html_css_files.append(l)
322
Mauro Carvalho Chehabfca72162021-12-07 10:52:59 +0100323if major <= 1 and minor < 8:
324 html_context = {
325 'css_files': [],
326 }
327
328 for l in html_css_files:
329 html_context['css_files'].append('_static/' + l)
330
Jonathan Corbet02d33e82022-10-11 11:25:25 -0600331if html_theme == 'alabaster':
Jonathan Corbetd5389d32022-09-23 16:28:57 -0600332 html_theme_options = {
333 'description': get_cline_version(),
Jonathan Corbet2056b922022-09-26 17:48:59 -0600334 'page_width': '65em',
335 'sidebar_width': '15em',
Jonathan Corbetc404f5d2023-01-19 17:03:05 -0700336 'fixed_sidebar': 'true',
Jonathan Corbetbd5d1cc2022-10-31 10:48:19 -0600337 'font_size': 'inherit',
338 'font_family': 'serif',
Jonathan Corbetd5389d32022-09-23 16:28:57 -0600339 }
Mauro Carvalho Chehabffc901b2021-12-07 10:53:01 +0100340
Mauro Carvalho Chehabfca72162021-12-07 10:52:59 +0100341sys.stderr.write("Using %s theme\n" % html_theme)
Jani Nikula22cba312016-05-19 15:14:05 +0300342
Jani Nikula22cba312016-05-19 15:14:05 +0300343# Add any paths that contain custom static files (such as style sheets) here,
344# relative to this directory. They are copied after the builtin static files,
345# so a file named "default.css" will overwrite the builtin "default.css".
Markus Heiserbc214672016-07-03 10:05:28 +0200346html_static_path = ['sphinx-static']
347
Jonathan Corbeteaae7572023-04-20 09:34:35 -0600348# If true, Docutils "smart quotes" will be used to convert quotes and dashes
349# to typographically correct entities. This will convert "--" to "—",
350# which is not always what we want, so disable it.
351smartquotes = False
Jani Nikula22cba312016-05-19 15:14:05 +0300352
353# Custom sidebar templates, maps document names to template names.
Jonathan Corbetd5389d32022-09-23 16:28:57 -0600354# Note that the RTD theme ignores this
Jonathan Corbetc404f5d2023-01-19 17:03:05 -0700355html_sidebars = { '**': ['searchbox.html', 'kernel-toc.html', 'sourcelink.html']}
Akira Yokosawaa33ae832023-01-10 18:47:25 +0900356
357# about.html is available for alabaster theme. Add it at the front.
358if html_theme == 'alabaster':
359 html_sidebars['**'].insert(0, 'about.html')
Jani Nikula22cba312016-05-19 15:14:05 +0300360
Vegard Nossumd49af112023-10-29 08:42:07 +0100361# The name of an image file (relative to this directory) to place at the top
362# of the sidebar.
363html_logo = 'images/logo.svg'
364
Jani Nikula22cba312016-05-19 15:14:05 +0300365# Output file base name for HTML help builder.
366htmlhelp_basename = 'TheLinuxKerneldoc'
367
368# -- Options for LaTeX output ---------------------------------------------
369
370latex_elements = {
Mauro Carvalho Chehab3b4c9632021-03-03 16:58:00 +0100371 # The paper size ('letterpaper' or 'a4paper').
372 'papersize': 'a4paper',
Jani Nikula22cba312016-05-19 15:14:05 +0300373
Mauro Carvalho Chehab3b4c9632021-03-03 16:58:00 +0100374 # The font size ('10pt', '11pt' or '12pt').
375 'pointsize': '11pt',
Jani Nikula22cba312016-05-19 15:14:05 +0300376
Mauro Carvalho Chehab3b4c9632021-03-03 16:58:00 +0100377 # Latex figure (float) alignment
378 #'figure_align': 'htbp',
Mauro Carvalho Chehabcaee5cd2016-08-16 13:25:37 -0300379
Mauro Carvalho Chehab3b4c9632021-03-03 16:58:00 +0100380 # Don't mangle with UTF-8 chars
381 'inputenc': '',
382 'utf8extra': '',
Mauro Carvalho Chehaba682ec42016-08-16 13:25:39 -0300383
Mauro Carvalho Chehab3b4c9632021-03-03 16:58:00 +0100384 # Set document margins
385 'sphinxsetup': '''
386 hmargin=0.5in, vmargin=1in,
387 parsedliteralwraps=true,
388 verbatimhintsturnover=false,
389 ''',
390
Akira Yokosawa77abc2c2021-08-09 10:23:57 +0900391 # For CJK One-half spacing, need to be in front of hyperref
392 'extrapackages': r'\usepackage{setspace}',
393
Mauro Carvalho Chehab3b4c9632021-03-03 16:58:00 +0100394 # Additional stuff for the LaTeX preamble.
Mauro Carvalho Chehabcaee5cd2016-08-16 13:25:37 -0300395 'preamble': '''
Mauro Carvalho Chehab3b4c9632021-03-03 16:58:00 +0100396 % Use some font with UTF-8 support with XeLaTeX
Mauro Carvalho Chehab9fdcd6a2017-09-03 16:12:46 -0300397 \\usepackage{fontspec}
Darrick J. Wong44ba0bb2018-10-04 18:06:03 -0700398 \\setsansfont{DejaVu Sans}
399 \\setromanfont{DejaVu Serif}
Mauro Carvalho Chehab9fdcd6a2017-09-03 16:12:46 -0300400 \\setmonofont{DejaVu Sans Mono}
Akira Yokosawa398f7ab2022-02-18 23:11:17 +0900401 ''',
Mauro Carvalho Chehabe0de2b52019-07-14 07:16:18 -0300402}
Mauro Carvalho Chehab9fdcd6a2017-09-03 16:12:46 -0300403
Mauro Carvalho Chehab9fdcd6a2017-09-03 16:12:46 -0300404# Fix reference escape troubles with Sphinx 1.4.x
Jonathan Corbetf546ff02021-02-01 16:26:25 -0700405if major == 1:
Mauro Carvalho Chehab9fdcd6a2017-09-03 16:12:46 -0300406 latex_elements['preamble'] += '\\renewcommand*{\\DUrole}[2]{ #2 }\n'
407
Akira Yokosawa398f7ab2022-02-18 23:11:17 +0900408
409# Load kerneldoc specific LaTeX settings
410latex_elements['preamble'] += '''
411 % Load kerneldoc specific LaTeX settings
412 \\input{kerneldoc-preamble.sty}
413'''
414
Mauro Carvalho Chehab9fdcd6a2017-09-03 16:12:46 -0300415# With Sphinx 1.6, it is possible to change the Bg color directly
416# by using:
417# \definecolor{sphinxnoteBgColor}{RGB}{204,255,255}
418# \definecolor{sphinxwarningBgColor}{RGB}{255,204,204}
419# \definecolor{sphinxattentionBgColor}{RGB}{255,255,204}
420# \definecolor{sphinximportantBgColor}{RGB}{192,255,204}
421#
422# However, it require to use sphinx heavy box with:
423#
424# \renewenvironment{sphinxlightbox} {%
425# \\begin{sphinxheavybox}
426# }
427# \\end{sphinxheavybox}
428# }
429#
430# Unfortunately, the implementation is buggy: if a note is inside a
431# table, it isn't displayed well. So, for now, let's use boring
432# black and white notes.
Mauro Carvalho Chehab633d6122017-06-19 07:49:06 -0300433
Jani Nikula22cba312016-05-19 15:14:05 +0300434# Grouping the document tree into LaTeX files. List of tuples
435# (source start file, target name, title,
436# author, documentclass [howto, manual, or own class]).
Mauro Carvalho Chehabc2b563d2017-05-12 06:02:12 -0300437# Sorted in alphabetical order
Jani Nikula22cba312016-05-19 15:14:05 +0300438latex_documents = [
Jani Nikula22cba312016-05-19 15:14:05 +0300439]
440
Mauro Carvalho Chehab9d42afb2019-07-09 06:52:36 -0300441# Add all other index files from Documentation/ subdirectories
442for fn in os.listdir('.'):
443 doc = os.path.join(fn, "index")
444 if os.path.exists(doc + ".rst"):
445 has = False
446 for l in latex_documents:
447 if l[0] == doc:
448 has = True
449 break
450 if not has:
451 latex_documents.append((doc, fn + '.tex',
452 'Linux %s Documentation' % fn.capitalize(),
453 'The kernel development community',
454 'manual'))
455
Jani Nikula22cba312016-05-19 15:14:05 +0300456# The name of an image file (relative to this directory) to place at the top of
457# the title page.
458#latex_logo = None
459
460# For "manual" documents, if this is true, then toplevel headings are parts,
461# not chapters.
462#latex_use_parts = False
463
464# If true, show page references after internal links.
465#latex_show_pagerefs = False
466
467# If true, show URL addresses after external links.
468#latex_show_urls = False
469
470# Documents to append as an appendix to all manuals.
471#latex_appendices = []
472
473# If false, no module index is generated.
474#latex_domain_indices = True
475
Akira Yokosawa398f7ab2022-02-18 23:11:17 +0900476# Additional LaTeX stuff to be copied to build directory
477latex_additional_files = [
478 'sphinx/kerneldoc-preamble.sty',
479]
480
Jani Nikula22cba312016-05-19 15:14:05 +0300481
482# -- Options for manual page output ---------------------------------------
483
484# One entry per manual page. List of tuples
485# (source start file, name, description, authors, manual section).
486man_pages = [
487 (master_doc, 'thelinuxkernel', 'The Linux Kernel Documentation',
488 [author], 1)
489]
490
491# If true, show URL addresses after external links.
492#man_show_urls = False
493
494
495# -- Options for Texinfo output -------------------------------------------
496
497# Grouping the document tree into Texinfo files. List of tuples
498# (source start file, target name, title, author,
499# dir menu entry, description, category)
500texinfo_documents = [
501 (master_doc, 'TheLinuxKernel', 'The Linux Kernel Documentation',
502 author, 'TheLinuxKernel', 'One line description of project.',
503 'Miscellaneous'),
504]
505
Jani Nikula22cba312016-05-19 15:14:05 +0300506# -- Options for Epub output ----------------------------------------------
507
508# Bibliographic Dublin Core info.
509epub_title = project
510epub_author = author
511epub_publisher = author
512epub_copyright = copyright
513
Jani Nikula22cba312016-05-19 15:14:05 +0300514# A list of files that should not be packed into the epub file.
515epub_exclude_files = ['search.html']
516
Jani Nikula22cba312016-05-19 15:14:05 +0300517#=======
518# rst2pdf
519#
520# Grouping the document tree into PDF files. List of tuples
521# (source start file, target name, title, author, options).
522#
Alexander A. Klimov93431e02020-05-26 08:05:44 +0200523# See the Sphinx chapter of https://ralsina.me/static/manual.pdf
Jani Nikula22cba312016-05-19 15:14:05 +0300524#
525# FIXME: Do not add the index file here; the result will be too big. Adding
526# multiple PDF files here actually tries to get the cross-referencing right
527# *between* PDF files.
528pdf_documents = [
Mauro Carvalho Chehab520a24772016-07-15 07:42:08 -0300529 ('kernel-documentation', u'Kernel', u'Kernel', u'J. Random Bozo'),
Jani Nikula22cba312016-05-19 15:14:05 +0300530]
Jani Nikula24dcdeb2016-05-20 11:51:47 +0300531
532# kernel-doc extension configuration for running Sphinx directly (e.g. by Read
533# the Docs). In a normal build, these are supplied from the Makefile via command
534# line arguments.
535kerneldoc_bin = '../scripts/kernel-doc'
536kerneldoc_srctree = '..'
Markus Heiser606b9ac2016-08-13 16:12:42 +0200537
538# ------------------------------------------------------------------------------
539# Since loadConfig overwrites settings from the global namespace, it has to be
540# the last statement in the conf.py file
541# ------------------------------------------------------------------------------
542loadConfig(globals())