Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
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
17import sphinx
18
19# Get Sphinx version
20major, minor, patch = sphinx.version_info[:3]
21
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.
26sys.path.insert(0, os.path.abspath('sphinx'))
27from load_config import loadConfig
28
29# -- General configuration ------------------------------------------------
30
31# If your documentation needs a minimal Sphinx version, state it here.
32needs_sphinx = '1.7'
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.
37extensions = ['kerneldoc', 'rstFlatTable', 'kernel_include',
38 'kfigure', 'sphinx.ext.ifconfig', 'automarkup',
39 'maintainers_include', 'sphinx.ext.autosectionlabel',
40 'kernel_abi', 'kernel_feat']
41
42if major >= 3:
43 if (major > 3) or (minor > 0 or patch >= 2):
44 # Sphinx c function parser is more pedantic with regards to type
45 # checking. Due to that, having macros at c:function cause problems.
46 # Those needed to be scaped by using c_id_attributes[] array
47 c_id_attributes = [
48 # GCC Compiler types not parsed by Sphinx:
49 "__restrict__",
50
51 # include/linux/compiler_types.h:
52 "__iomem",
53 "__kernel",
54 "noinstr",
55 "notrace",
56 "__percpu",
57 "__rcu",
58 "__user",
59
60 # include/linux/compiler_attributes.h:
61 "__alias",
62 "__aligned",
63 "__aligned_largest",
64 "__always_inline",
65 "__assume_aligned",
66 "__cold",
67 "__attribute_const__",
68 "__copy",
69 "__pure",
70 "__designated_init",
71 "__visible",
72 "__printf",
73 "__scanf",
74 "__gnu_inline",
75 "__malloc",
76 "__mode",
77 "__no_caller_saved_registers",
78 "__noclone",
79 "__nonstring",
80 "__noreturn",
81 "__packed",
82 "__pure",
83 "__section",
84 "__always_unused",
85 "__maybe_unused",
86 "__used",
87 "__weak",
88 "noinline",
89
90 # include/linux/memblock.h:
91 "__init_memblock",
92 "__meminit",
93
94 # include/linux/init.h:
95 "__init",
96 "__ref",
97
98 # include/linux/linkage.h:
99 "asmlinkage",
100 ]
101
102else:
103 extensions.append('cdomain')
104
105# Ensure that autosectionlabel will produce unique names
106autosectionlabel_prefix_document = True
107autosectionlabel_maxdepth = 2
108
109extensions.append("sphinx.ext.imgmath")
110
111# Add any paths that contain templates here, relative to this directory.
112templates_path = ['_templates']
113
114# The suffix(es) of source filenames.
115# You can specify multiple suffix as a list of string:
116# source_suffix = ['.rst', '.md']
117source_suffix = '.rst'
118
119# The encoding of source files.
120#source_encoding = 'utf-8-sig'
121
122# The master toctree document.
123master_doc = 'index'
124
125# General information about the project.
126project = 'The Linux Kernel'
127copyright = 'The kernel development community'
128author = 'The kernel development community'
129
130# The version info for the project you're documenting, acts as replacement for
131# |version| and |release|, also used in various other places throughout the
132# built documents.
133#
134# In a normal build, version and release are are set to KERNELVERSION and
135# KERNELRELEASE, respectively, from the Makefile via Sphinx command line
136# arguments.
137#
138# The following code tries to extract the information by reading the Makefile,
139# when Sphinx is run directly (e.g. by Read the Docs).
140try:
141 makefile_version = None
142 makefile_patchlevel = None
143 for line in open('../Makefile'):
144 key, val = [x.strip() for x in line.split('=', 2)]
145 if key == 'VERSION':
146 makefile_version = val
147 elif key == 'PATCHLEVEL':
148 makefile_patchlevel = val
149 if makefile_version and makefile_patchlevel:
150 break
151except:
152 pass
153finally:
154 if makefile_version and makefile_patchlevel:
155 version = release = makefile_version + '.' + makefile_patchlevel
156 else:
157 version = release = "unknown version"
158
159# The language for content autogenerated by Sphinx. Refer to documentation
160# for a list of supported languages.
161#
162# This is also used if you do content translation via gettext catalogs.
163# Usually you set "language" from the command line for these cases.
164language = None
165
166# There are two options for replacing |today|: either, you set today to some
167# non-false value, then it is used:
168#today = ''
169# Else, today_fmt is used as the format for a strftime call.
170#today_fmt = '%B %d, %Y'
171
172# List of patterns, relative to source directory, that match files and
173# directories to ignore when looking for source files.
174exclude_patterns = ['output']
175
176# The reST default role (used for this markup: `text`) to use for all
177# documents.
178#default_role = None
179
180# If true, '()' will be appended to :func: etc. cross-reference text.
181#add_function_parentheses = True
182
183# If true, the current module name will be prepended to all description
184# unit titles (such as .. function::).
185#add_module_names = True
186
187# If true, sectionauthor and moduleauthor directives will be shown in the
188# output. They are ignored by default.
189#show_authors = False
190
191# The name of the Pygments (syntax highlighting) style to use.
192pygments_style = 'sphinx'
193
194# A list of ignored prefixes for module index sorting.
195#modindex_common_prefix = []
196
197# If true, keep warnings as "system message" paragraphs in the built documents.
198#keep_warnings = False
199
200# If true, `todo` and `todoList` produce output, else they produce nothing.
201todo_include_todos = False
202
203primary_domain = 'c'
204highlight_language = 'none'
205
206# -- Options for HTML output ----------------------------------------------
207
208# The theme to use for HTML and HTML Help pages. See the documentation for
209# a list of builtin themes.
210
211# Default theme
212html_theme = 'sphinx_rtd_theme'
213html_css_files = []
214
215if "DOCS_THEME" in os.environ:
216 html_theme = os.environ["DOCS_THEME"]
217
218if html_theme == 'sphinx_rtd_theme' or html_theme == 'sphinx_rtd_dark_mode':
219 # Read the Docs theme
220 try:
221 import sphinx_rtd_theme
222 html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
223
224 # Add any paths that contain custom static files (such as style sheets) here,
225 # relative to this directory. They are copied after the builtin static files,
226 # so a file named "default.css" will overwrite the builtin "default.css".
227 html_css_files = [
228 'theme_overrides.css',
229 ]
230
231 # Read the Docs dark mode override theme
232 if html_theme == 'sphinx_rtd_dark_mode':
233 try:
234 import sphinx_rtd_dark_mode
235 extensions.append('sphinx_rtd_dark_mode')
236 except ImportError:
237 html_theme == 'sphinx_rtd_theme'
238
239 if html_theme == 'sphinx_rtd_theme':
240 # Add color-specific RTD normal mode
241 html_css_files.append('theme_rtd_colors.css')
242
243 except ImportError:
244 html_theme = 'classic'
245
246if "DOCS_CSS" in os.environ:
247 css = os.environ["DOCS_CSS"].split(" ")
248
249 for l in css:
250 html_css_files.append(l)
251
252if major <= 1 and minor < 8:
253 html_context = {
254 'css_files': [],
255 }
256
257 for l in html_css_files:
258 html_context['css_files'].append('_static/' + l)
259
260if html_theme == 'classic':
261 html_theme_options = {
262 'rightsidebar': False,
263 'stickysidebar': True,
264 'collapsiblesidebar': True,
265 'externalrefs': False,
266
267 'footerbgcolor': "white",
268 'footertextcolor': "white",
269 'sidebarbgcolor': "white",
270 'sidebarbtncolor': "black",
271 'sidebartextcolor': "black",
272 'sidebarlinkcolor': "#686bff",
273 'relbarbgcolor': "#133f52",
274 'relbartextcolor': "white",
275 'relbarlinkcolor': "white",
276 'bgcolor': "white",
277 'textcolor': "black",
278 'headbgcolor': "#f2f2f2",
279 'headtextcolor': "#20435c",
280 'headlinkcolor': "#c60f0f",
281 'linkcolor': "#355f7c",
282 'visitedlinkcolor': "#355f7c",
283 'codebgcolor': "#3f3f3f",
284 'codetextcolor': "white",
285
286 'bodyfont': "serif",
287 'headfont': "sans-serif",
288 }
289
290sys.stderr.write("Using %s theme\n" % html_theme)
291
292# Theme options are theme-specific and customize the look and feel of a theme
293# further. For a list of options available for each theme, see the
294# documentation.
295#html_theme_options = {}
296
297# Add any paths that contain custom themes here, relative to this directory.
298#html_theme_path = []
299
300# The name for this set of Sphinx documents. If None, it defaults to
301# "<project> v<release> documentation".
302#html_title = None
303
304# A shorter title for the navigation bar. Default is the same as html_title.
305#html_short_title = None
306
307# The name of an image file (relative to this directory) to place at the top
308# of the sidebar.
309#html_logo = None
310
311# The name of an image file (within the static path) to use as favicon of the
312# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
313# pixels large.
314#html_favicon = None
315
316# Add any paths that contain custom static files (such as style sheets) here,
317# relative to this directory. They are copied after the builtin static files,
318# so a file named "default.css" will overwrite the builtin "default.css".
319html_static_path = ['sphinx-static']
320
321# Add any extra paths that contain custom files (such as robots.txt or
322# .htaccess) here, relative to this directory. These files are copied
323# directly to the root of the documentation.
324#html_extra_path = []
325
326# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
327# using the given strftime format.
328#html_last_updated_fmt = '%b %d, %Y'
329
330# If true, SmartyPants will be used to convert quotes and dashes to
331# typographically correct entities.
332html_use_smartypants = False
333
334# Custom sidebar templates, maps document names to template names.
335#html_sidebars = {}
336
337# Additional templates that should be rendered to pages, maps page names to
338# template names.
339#html_additional_pages = {}
340
341# If false, no module index is generated.
342#html_domain_indices = True
343
344# If false, no index is generated.
345#html_use_index = True
346
347# If true, the index is split into individual pages for each letter.
348#html_split_index = False
349
350# If true, links to the reST sources are added to the pages.
351#html_show_sourcelink = True
352
353# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
354#html_show_sphinx = True
355
356# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
357#html_show_copyright = True
358
359# If true, an OpenSearch description file will be output, and all pages will
360# contain a <link> tag referring to it. The value of this option must be the
361# base URL from which the finished HTML is served.
362#html_use_opensearch = ''
363
364# This is the file name suffix for HTML files (e.g. ".xhtml").
365#html_file_suffix = None
366
367# Language to be used for generating the HTML full-text search index.
368# Sphinx supports the following languages:
369# 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja'
370# 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr'
371#html_search_language = 'en'
372
373# A dictionary with options for the search language support, empty by default.
374# Now only 'ja' uses this config value
375#html_search_options = {'type': 'default'}
376
377# The name of a javascript file (relative to the configuration directory) that
378# implements a search results scorer. If empty, the default will be used.
379#html_search_scorer = 'scorer.js'
380
381# Output file base name for HTML help builder.
382htmlhelp_basename = 'TheLinuxKerneldoc'
383
384# -- Options for LaTeX output ---------------------------------------------
385
386latex_elements = {
387 # The paper size ('letterpaper' or 'a4paper').
388 'papersize': 'a4paper',
389
390 # The font size ('10pt', '11pt' or '12pt').
391 'pointsize': '11pt',
392
393 # Latex figure (float) alignment
394 #'figure_align': 'htbp',
395
396 # Don't mangle with UTF-8 chars
397 'inputenc': '',
398 'utf8extra': '',
399
400 # Set document margins
401 'sphinxsetup': '''
402 hmargin=0.5in, vmargin=1in,
403 parsedliteralwraps=true,
404 verbatimhintsturnover=false,
405 ''',
406
407 # For CJK One-half spacing, need to be in front of hyperref
408 'extrapackages': r'\usepackage{setspace}',
409
410 # Additional stuff for the LaTeX preamble.
411 'preamble': '''
412 % Prevent column squeezing of tabulary.
413 \\setlength{\\tymin}{20em}
414 % Use some font with UTF-8 support with XeLaTeX
415 \\usepackage{fontspec}
416 \\setsansfont{DejaVu Sans}
417 \\setromanfont{DejaVu Serif}
418 \\setmonofont{DejaVu Sans Mono}
419 % Adjust \\headheight for fancyhdr
420 \\addtolength{\\headheight}{1.6pt}
421 \\addtolength{\\topmargin}{-1.6pt}
422 ''',
423}
424
425# Translations have Asian (CJK) characters which are only displayed if
426# xeCJK is used
427
428latex_elements['preamble'] += '''
429 \\IfFontExistsTF{Noto Sans CJK SC}{
430 % This is needed for translations
431 \\usepackage{xeCJK}
432 \\IfFontExistsTF{Noto Serif CJK SC}{
433 \\setCJKmainfont{Noto Serif CJK SC}[AutoFakeSlant]
434 }{
435 \\setCJKmainfont{Noto Sans CJK SC}[AutoFakeSlant]
436 }
437 \\setCJKsansfont{Noto Sans CJK SC}[AutoFakeSlant]
438 \\setCJKmonofont{Noto Sans Mono CJK SC}[AutoFakeSlant]
439 % CJK Language-specific font choices
440 \\IfFontExistsTF{Noto Serif CJK SC}{
441 \\newCJKfontfamily[SCmain]\\scmain{Noto Serif CJK SC}[AutoFakeSlant]
442 \\newCJKfontfamily[SCserif]\\scserif{Noto Serif CJK SC}[AutoFakeSlant]
443 }{
444 \\newCJKfontfamily[SCmain]\\scmain{Noto Sans CJK SC}[AutoFakeSlant]
445 \\newCJKfontfamily[SCserif]\\scserif{Noto Sans CJK SC}[AutoFakeSlant]
446 }
447 \\newCJKfontfamily[SCsans]\\scsans{Noto Sans CJK SC}[AutoFakeSlant]
448 \\newCJKfontfamily[SCmono]\\scmono{Noto Sans Mono CJK SC}[AutoFakeSlant]
449 \\IfFontExistsTF{Noto Serif CJK TC}{
450 \\newCJKfontfamily[TCmain]\\tcmain{Noto Serif CJK TC}[AutoFakeSlant]
451 \\newCJKfontfamily[TCserif]\\tcserif{Noto Serif CJK TC}[AutoFakeSlant]
452 }{
453 \\newCJKfontfamily[TCmain]\\tcmain{Noto Sans CJK TC}[AutoFakeSlant]
454 \\newCJKfontfamily[TCserif]\\tcserif{Noto Sans CJK TC}[AutoFakeSlant]
455 }
456 \\newCJKfontfamily[TCsans]\\tcsans{Noto Sans CJK TC}[AutoFakeSlant]
457 \\newCJKfontfamily[TCmono]\\tcmono{Noto Sans Mono CJK TC}[AutoFakeSlant]
458 \\IfFontExistsTF{Noto Serif CJK KR}{
459 \\newCJKfontfamily[KRmain]\\krmain{Noto Serif CJK KR}[AutoFakeSlant]
460 \\newCJKfontfamily[KRserif]\\krserif{Noto Serif CJK KR}[AutoFakeSlant]
461 }{
462 \\newCJKfontfamily[KRmain]\\krmain{Noto Sans CJK KR}[AutoFakeSlant]
463 \\newCJKfontfamily[KRserif]\\krserif{Noto Sans CJK KR}[AutoFakeSlant]
464 }
465 \\newCJKfontfamily[KRsans]\\krsans{Noto Sans CJK KR}[AutoFakeSlant]
466 \\newCJKfontfamily[KRmono]\\krmono{Noto Sans Mono CJK KR}[AutoFakeSlant]
467 \\IfFontExistsTF{Noto Serif CJK JP}{
468 \\newCJKfontfamily[JPmain]\\jpmain{Noto Serif CJK JP}[AutoFakeSlant]
469 \\newCJKfontfamily[JPserif]\\jpserif{Noto Serif CJK JP}[AutoFakeSlant]
470 }{
471 \\newCJKfontfamily[JPmain]\\jpmain{Noto Sans CJK JP}[AutoFakeSlant]
472 \\newCJKfontfamily[JPserif]\\jpserif{Noto Sans CJK JP}[AutoFakeSlant]
473 }
474 \\newCJKfontfamily[JPsans]\\jpsans{Noto Sans CJK JP}[AutoFakeSlant]
475 \\newCJKfontfamily[JPmono]\\jpmono{Noto Sans Mono CJK JP}[AutoFakeSlant]
476 % Dummy commands for Sphinx < 2.3 (no 'extrapackages' support)
477 \\providecommand{\\onehalfspacing}{}
478 \\providecommand{\\singlespacing}{}
479 % Define custom macros to on/off CJK
480 \\newcommand{\\kerneldocCJKon}{\\makexeCJKactive\\onehalfspacing}
481 \\newcommand{\\kerneldocCJKoff}{\\makexeCJKinactive\\singlespacing}
482 \\newcommand{\\kerneldocBeginSC}{%
483 \\begingroup%
484 \\scmain%
485 }
486 \\newcommand{\\kerneldocEndSC}{\\endgroup}
487 \\newcommand{\\kerneldocBeginTC}{%
488 \\begingroup%
489 \\tcmain%
490 \\renewcommand{\\CJKrmdefault}{TCserif}%
491 \\renewcommand{\\CJKsfdefault}{TCsans}%
492 \\renewcommand{\\CJKttdefault}{TCmono}%
493 }
494 \\newcommand{\\kerneldocEndTC}{\\endgroup}
495 \\newcommand{\\kerneldocBeginKR}{%
496 \\begingroup%
497 \\xeCJKDeclareCharClass{HalfLeft}{`“,`‘}%
498 \\xeCJKDeclareCharClass{HalfRight}{`”,`’}%
499 \\krmain%
500 \\renewcommand{\\CJKrmdefault}{KRserif}%
501 \\renewcommand{\\CJKsfdefault}{KRsans}%
502 \\renewcommand{\\CJKttdefault}{KRmono}%
503 \\xeCJKsetup{CJKspace = true} % For inter-phrase space
504 }
505 \\newcommand{\\kerneldocEndKR}{\\endgroup}
506 \\newcommand{\\kerneldocBeginJP}{%
507 \\begingroup%
508 \\xeCJKDeclareCharClass{HalfLeft}{`“,`‘}%
509 \\xeCJKDeclareCharClass{HalfRight}{`”,`’}%
510 \\jpmain%
511 \\renewcommand{\\CJKrmdefault}{JPserif}%
512 \\renewcommand{\\CJKsfdefault}{JPsans}%
513 \\renewcommand{\\CJKttdefault}{JPmono}%
514 }
515 \\newcommand{\\kerneldocEndJP}{\\endgroup}
516 % Single spacing in literal blocks
517 \\fvset{baselinestretch=1}
518 % To customize \\sphinxtableofcontents
519 \\usepackage{etoolbox}
520 % Inactivate CJK after tableofcontents
521 \\apptocmd{\\sphinxtableofcontents}{\\kerneldocCJKoff}{}{}
522 }{ % No CJK font found
523 % Custom macros to on/off CJK (Dummy)
524 \\newcommand{\\kerneldocCJKon}{}
525 \\newcommand{\\kerneldocCJKoff}{}
526 \\newcommand{\\kerneldocBeginSC}{}
527 \\newcommand{\\kerneldocEndSC}{}
528 \\newcommand{\\kerneldocBeginTC}{}
529 \\newcommand{\\kerneldocEndTC}{}
530 \\newcommand{\\kerneldocBeginKR}{}
531 \\newcommand{\\kerneldocEndKR}{}
532 \\newcommand{\\kerneldocBeginJP}{}
533 \\newcommand{\\kerneldocEndJP}{}
534 }
535'''
536
537# Fix reference escape troubles with Sphinx 1.4.x
538if major == 1:
539 latex_elements['preamble'] += '\\renewcommand*{\\DUrole}[2]{ #2 }\n'
540
541# With Sphinx 1.6, it is possible to change the Bg color directly
542# by using:
543# \definecolor{sphinxnoteBgColor}{RGB}{204,255,255}
544# \definecolor{sphinxwarningBgColor}{RGB}{255,204,204}
545# \definecolor{sphinxattentionBgColor}{RGB}{255,255,204}
546# \definecolor{sphinximportantBgColor}{RGB}{192,255,204}
547#
548# However, it require to use sphinx heavy box with:
549#
550# \renewenvironment{sphinxlightbox} {%
551# \\begin{sphinxheavybox}
552# }
553# \\end{sphinxheavybox}
554# }
555#
556# Unfortunately, the implementation is buggy: if a note is inside a
557# table, it isn't displayed well. So, for now, let's use boring
558# black and white notes.
559
560# Grouping the document tree into LaTeX files. List of tuples
561# (source start file, target name, title,
562# author, documentclass [howto, manual, or own class]).
563# Sorted in alphabetical order
564latex_documents = [
565]
566
567# Add all other index files from Documentation/ subdirectories
568for fn in os.listdir('.'):
569 doc = os.path.join(fn, "index")
570 if os.path.exists(doc + ".rst"):
571 has = False
572 for l in latex_documents:
573 if l[0] == doc:
574 has = True
575 break
576 if not has:
577 latex_documents.append((doc, fn + '.tex',
578 'Linux %s Documentation' % fn.capitalize(),
579 'The kernel development community',
580 'manual'))
581
582# The name of an image file (relative to this directory) to place at the top of
583# the title page.
584#latex_logo = None
585
586# For "manual" documents, if this is true, then toplevel headings are parts,
587# not chapters.
588#latex_use_parts = False
589
590# If true, show page references after internal links.
591#latex_show_pagerefs = False
592
593# If true, show URL addresses after external links.
594#latex_show_urls = False
595
596# Documents to append as an appendix to all manuals.
597#latex_appendices = []
598
599# If false, no module index is generated.
600#latex_domain_indices = True
601
602
603# -- Options for manual page output ---------------------------------------
604
605# One entry per manual page. List of tuples
606# (source start file, name, description, authors, manual section).
607man_pages = [
608 (master_doc, 'thelinuxkernel', 'The Linux Kernel Documentation',
609 [author], 1)
610]
611
612# If true, show URL addresses after external links.
613#man_show_urls = False
614
615
616# -- Options for Texinfo output -------------------------------------------
617
618# Grouping the document tree into Texinfo files. List of tuples
619# (source start file, target name, title, author,
620# dir menu entry, description, category)
621texinfo_documents = [
622 (master_doc, 'TheLinuxKernel', 'The Linux Kernel Documentation',
623 author, 'TheLinuxKernel', 'One line description of project.',
624 'Miscellaneous'),
625]
626
627# Documents to append as an appendix to all manuals.
628#texinfo_appendices = []
629
630# If false, no module index is generated.
631#texinfo_domain_indices = True
632
633# How to display URL addresses: 'footnote', 'no', or 'inline'.
634#texinfo_show_urls = 'footnote'
635
636# If true, do not generate a @detailmenu in the "Top" node's menu.
637#texinfo_no_detailmenu = False
638
639
640# -- Options for Epub output ----------------------------------------------
641
642# Bibliographic Dublin Core info.
643epub_title = project
644epub_author = author
645epub_publisher = author
646epub_copyright = copyright
647
648# The basename for the epub file. It defaults to the project name.
649#epub_basename = project
650
651# The HTML theme for the epub output. Since the default themes are not
652# optimized for small screen space, using the same theme for HTML and epub
653# output is usually not wise. This defaults to 'epub', a theme designed to save
654# visual space.
655#epub_theme = 'epub'
656
657# The language of the text. It defaults to the language option
658# or 'en' if the language is not set.
659#epub_language = ''
660
661# The scheme of the identifier. Typical schemes are ISBN or URL.
662#epub_scheme = ''
663
664# The unique identifier of the text. This can be a ISBN number
665# or the project homepage.
666#epub_identifier = ''
667
668# A unique identification for the text.
669#epub_uid = ''
670
671# A tuple containing the cover image and cover page html template filenames.
672#epub_cover = ()
673
674# A sequence of (type, uri, title) tuples for the guide element of content.opf.
675#epub_guide = ()
676
677# HTML files that should be inserted before the pages created by sphinx.
678# The format is a list of tuples containing the path and title.
679#epub_pre_files = []
680
681# HTML files that should be inserted after the pages created by sphinx.
682# The format is a list of tuples containing the path and title.
683#epub_post_files = []
684
685# A list of files that should not be packed into the epub file.
686epub_exclude_files = ['search.html']
687
688# The depth of the table of contents in toc.ncx.
689#epub_tocdepth = 3
690
691# Allow duplicate toc entries.
692#epub_tocdup = True
693
694# Choose between 'default' and 'includehidden'.
695#epub_tocscope = 'default'
696
697# Fix unsupported image types using the Pillow.
698#epub_fix_images = False
699
700# Scale large images.
701#epub_max_image_width = 0
702
703# How to display URL addresses: 'footnote', 'no', or 'inline'.
704#epub_show_urls = 'inline'
705
706# If false, no index is generated.
707#epub_use_index = True
708
709#=======
710# rst2pdf
711#
712# Grouping the document tree into PDF files. List of tuples
713# (source start file, target name, title, author, options).
714#
715# See the Sphinx chapter of https://ralsina.me/static/manual.pdf
716#
717# FIXME: Do not add the index file here; the result will be too big. Adding
718# multiple PDF files here actually tries to get the cross-referencing right
719# *between* PDF files.
720pdf_documents = [
721 ('kernel-documentation', u'Kernel', u'Kernel', u'J. Random Bozo'),
722]
723
724# kernel-doc extension configuration for running Sphinx directly (e.g. by Read
725# the Docs). In a normal build, these are supplied from the Makefile via command
726# line arguments.
727kerneldoc_bin = '../scripts/kernel-doc'
728kerneldoc_srctree = '..'
729
730# ------------------------------------------------------------------------------
731# Since loadConfig overwrites settings from the global namespace, it has to be
732# the last statement in the conf.py file
733# ------------------------------------------------------------------------------
734loadConfig(globals())