docs: allow to pass extra DOCS_CSS themes via make
[linux-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.
f546ff0c 32needs_sphinx = '1.7'
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.
afde706a 37extensions = ['kerneldoc', 'rstFlatTable', 'kernel_include',
aa204855 38 'kfigure', 'sphinx.ext.ifconfig', 'automarkup',
a7ee04b3 39 'maintainers_include', 'sphinx.ext.autosectionlabel',
63fdc462 40 'kernel_abi', 'kernel_feat']
22cba31b 41
afde706a 42if major >= 3:
d29f34c0 43 if (major > 3) or (minor > 0 or patch >= 2):
b34b86d7
MCC
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
afde706a
JC
102else:
103 extensions.append('cdomain')
104
4658b0eb
MCC
105# Ensure that autosectionlabel will produce unique names
106autosectionlabel_prefix_document = True
107autosectionlabel_maxdepth = 2
108
f546ff0c 109extensions.append("sphinx.ext.imgmath")
22cba31b
JN
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'
dc36143f 127copyright = 'The kernel development community'
22cba31b
JN
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#
c13ce448
JN
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:
c13ce448 157 version = release = "unknown version"
22cba31b
JN
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
fd5d6669 203primary_domain = 'c'
b459106e 204highlight_language = 'none'
22cba31b
JN
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
fca7216b
MCC
211# Default theme
212html_theme = 'sphinx_rtd_theme'
135707d3 213html_css_files = []
fca7216b
MCC
214
215if "DOCS_THEME" in os.environ:
216 html_theme = os.environ["DOCS_THEME"]
217
218if html_theme == 'sphinx_rtd_theme':
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 except ImportError:
231 html_theme = 'classic'
232
135707d3
MCC
233if "DOCS_CSS" in os.environ:
234 css = os.environ["DOCS_CSS"].split(" ")
235
236 for l in css:
237 html_css_files.append(l)
238
fca7216b
MCC
239if major <= 1 and minor < 8:
240 html_context = {
241 'css_files': [],
242 }
243
244 for l in html_css_files:
245 html_context['css_files'].append('_static/' + l)
246
247sys.stderr.write("Using %s theme\n" % html_theme)
22cba31b
JN
248
249# Theme options are theme-specific and customize the look and feel of a theme
250# further. For a list of options available for each theme, see the
251# documentation.
252#html_theme_options = {}
253
254# Add any paths that contain custom themes here, relative to this directory.
255#html_theme_path = []
256
257# The name for this set of Sphinx documents. If None, it defaults to
258# "<project> v<release> documentation".
259#html_title = None
260
261# A shorter title for the navigation bar. Default is the same as html_title.
262#html_short_title = None
263
264# The name of an image file (relative to this directory) to place at the top
265# of the sidebar.
266#html_logo = None
267
268# The name of an image file (within the static path) to use as favicon of the
269# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
270# pixels large.
271#html_favicon = None
272
273# Add any paths that contain custom static files (such as style sheets) here,
274# relative to this directory. They are copied after the builtin static files,
275# so a file named "default.css" will overwrite the builtin "default.css".
bc214671
MH
276html_static_path = ['sphinx-static']
277
22cba31b
JN
278# Add any extra paths that contain custom files (such as robots.txt or
279# .htaccess) here, relative to this directory. These files are copied
280# directly to the root of the documentation.
281#html_extra_path = []
282
283# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
284# using the given strftime format.
285#html_last_updated_fmt = '%b %d, %Y'
286
287# If true, SmartyPants will be used to convert quotes and dashes to
288# typographically correct entities.
7282a93f 289html_use_smartypants = False
22cba31b
JN
290
291# Custom sidebar templates, maps document names to template names.
292#html_sidebars = {}
293
294# Additional templates that should be rendered to pages, maps page names to
295# template names.
296#html_additional_pages = {}
297
298# If false, no module index is generated.
299#html_domain_indices = True
300
301# If false, no index is generated.
302#html_use_index = True
303
304# If true, the index is split into individual pages for each letter.
305#html_split_index = False
306
307# If true, links to the reST sources are added to the pages.
308#html_show_sourcelink = True
309
310# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
311#html_show_sphinx = True
312
313# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
314#html_show_copyright = True
315
316# If true, an OpenSearch description file will be output, and all pages will
317# contain a <link> tag referring to it. The value of this option must be the
318# base URL from which the finished HTML is served.
319#html_use_opensearch = ''
320
321# This is the file name suffix for HTML files (e.g. ".xhtml").
322#html_file_suffix = None
323
324# Language to be used for generating the HTML full-text search index.
325# Sphinx supports the following languages:
326# 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja'
327# 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr'
328#html_search_language = 'en'
329
330# A dictionary with options for the search language support, empty by default.
331# Now only 'ja' uses this config value
332#html_search_options = {'type': 'default'}
333
334# The name of a javascript file (relative to the configuration directory) that
335# implements a search results scorer. If empty, the default will be used.
336#html_search_scorer = 'scorer.js'
337
338# Output file base name for HTML help builder.
339htmlhelp_basename = 'TheLinuxKerneldoc'
340
341# -- Options for LaTeX output ---------------------------------------------
342
343latex_elements = {
3b4c9632
MCC
344 # The paper size ('letterpaper' or 'a4paper').
345 'papersize': 'a4paper',
22cba31b 346
3b4c9632
MCC
347 # The font size ('10pt', '11pt' or '12pt').
348 'pointsize': '11pt',
22cba31b 349
3b4c9632
MCC
350 # Latex figure (float) alignment
351 #'figure_align': 'htbp',
caee5cde 352
3b4c9632
MCC
353 # Don't mangle with UTF-8 chars
354 'inputenc': '',
355 'utf8extra': '',
a682ec4b 356
3b4c9632
MCC
357 # Set document margins
358 'sphinxsetup': '''
359 hmargin=0.5in, vmargin=1in,
360 parsedliteralwraps=true,
361 verbatimhintsturnover=false,
362 ''',
363
77abc2c2
AY
364 # For CJK One-half spacing, need to be in front of hyperref
365 'extrapackages': r'\usepackage{setspace}',
366
3b4c9632 367 # Additional stuff for the LaTeX preamble.
caee5cde 368 'preamble': '''
0afd4df0
AY
369 % Prevent column squeezing of tabulary.
370 \\setlength{\\tymin}{20em}
3b4c9632 371 % Use some font with UTF-8 support with XeLaTeX
9fdcd6af 372 \\usepackage{fontspec}
44ba0bb4
DW
373 \\setsansfont{DejaVu Sans}
374 \\setromanfont{DejaVu Serif}
9fdcd6af 375 \\setmonofont{DejaVu Sans Mono}
aa872e06
AY
376 % Adjust \\headheight for fancyhdr
377 \\addtolength{\\headheight}{1.6pt}
378 \\addtolength{\\topmargin}{-1.6pt}
3b4c9632 379 ''',
e0de2b59 380}
9fdcd6af 381
659653c9
AY
382# Translations have Asian (CJK) characters which are only displayed if
383# xeCJK is used
e0de2b59 384
659653c9
AY
385latex_elements['preamble'] += '''
386 \\IfFontExistsTF{Noto Sans CJK SC}{
24889dad 387 % This is needed for translations
659653c9 388 \\usepackage{xeCJK}
7eb368cc 389 \\IfFontExistsTF{Noto Serif CJK SC}{
788d28a2 390 \\setCJKmainfont{Noto Serif CJK SC}[AutoFakeSlant]
7eb368cc 391 }{
788d28a2 392 \\setCJKmainfont{Noto Sans CJK SC}[AutoFakeSlant]
7eb368cc 393 }
788d28a2
AY
394 \\setCJKsansfont{Noto Sans CJK SC}[AutoFakeSlant]
395 \\setCJKmonofont{Noto Sans Mono CJK SC}[AutoFakeSlant]
e291ff6f 396 % CJK Language-specific font choices
7eb368cc 397 \\IfFontExistsTF{Noto Serif CJK SC}{
788d28a2
AY
398 \\newCJKfontfamily[SCmain]\\scmain{Noto Serif CJK SC}[AutoFakeSlant]
399 \\newCJKfontfamily[SCserif]\\scserif{Noto Serif CJK SC}[AutoFakeSlant]
7eb368cc 400 }{
788d28a2
AY
401 \\newCJKfontfamily[SCmain]\\scmain{Noto Sans CJK SC}[AutoFakeSlant]
402 \\newCJKfontfamily[SCserif]\\scserif{Noto Sans CJK SC}[AutoFakeSlant]
7eb368cc 403 }
788d28a2
AY
404 \\newCJKfontfamily[SCsans]\\scsans{Noto Sans CJK SC}[AutoFakeSlant]
405 \\newCJKfontfamily[SCmono]\\scmono{Noto Sans Mono CJK SC}[AutoFakeSlant]
7eb368cc 406 \\IfFontExistsTF{Noto Serif CJK TC}{
788d28a2
AY
407 \\newCJKfontfamily[TCmain]\\tcmain{Noto Serif CJK TC}[AutoFakeSlant]
408 \\newCJKfontfamily[TCserif]\\tcserif{Noto Serif CJK TC}[AutoFakeSlant]
7eb368cc 409 }{
788d28a2
AY
410 \\newCJKfontfamily[TCmain]\\tcmain{Noto Sans CJK TC}[AutoFakeSlant]
411 \\newCJKfontfamily[TCserif]\\tcserif{Noto Sans CJK TC}[AutoFakeSlant]
7eb368cc 412 }
788d28a2
AY
413 \\newCJKfontfamily[TCsans]\\tcsans{Noto Sans CJK TC}[AutoFakeSlant]
414 \\newCJKfontfamily[TCmono]\\tcmono{Noto Sans Mono CJK TC}[AutoFakeSlant]
7eb368cc 415 \\IfFontExistsTF{Noto Serif CJK KR}{
788d28a2
AY
416 \\newCJKfontfamily[KRmain]\\krmain{Noto Serif CJK KR}[AutoFakeSlant]
417 \\newCJKfontfamily[KRserif]\\krserif{Noto Serif CJK KR}[AutoFakeSlant]
7eb368cc 418 }{
788d28a2
AY
419 \\newCJKfontfamily[KRmain]\\krmain{Noto Sans CJK KR}[AutoFakeSlant]
420 \\newCJKfontfamily[KRserif]\\krserif{Noto Sans CJK KR}[AutoFakeSlant]
7eb368cc 421 }
788d28a2
AY
422 \\newCJKfontfamily[KRsans]\\krsans{Noto Sans CJK KR}[AutoFakeSlant]
423 \\newCJKfontfamily[KRmono]\\krmono{Noto Sans Mono CJK KR}[AutoFakeSlant]
7eb368cc 424 \\IfFontExistsTF{Noto Serif CJK JP}{
788d28a2
AY
425 \\newCJKfontfamily[JPmain]\\jpmain{Noto Serif CJK JP}[AutoFakeSlant]
426 \\newCJKfontfamily[JPserif]\\jpserif{Noto Serif CJK JP}[AutoFakeSlant]
7eb368cc 427 }{
788d28a2
AY
428 \\newCJKfontfamily[JPmain]\\jpmain{Noto Sans CJK JP}[AutoFakeSlant]
429 \\newCJKfontfamily[JPserif]\\jpserif{Noto Sans CJK JP}[AutoFakeSlant]
7eb368cc 430 }
788d28a2
AY
431 \\newCJKfontfamily[JPsans]\\jpsans{Noto Sans CJK JP}[AutoFakeSlant]
432 \\newCJKfontfamily[JPmono]\\jpmono{Noto Sans Mono CJK JP}[AutoFakeSlant]
77abc2c2
AY
433 % Dummy commands for Sphinx < 2.3 (no 'extrapackages' support)
434 \\providecommand{\\onehalfspacing}{}
435 \\providecommand{\\singlespacing}{}
f7ebe6b7 436 % Define custom macros to on/off CJK
77abc2c2
AY
437 \\newcommand{\\kerneldocCJKon}{\\makexeCJKactive\\onehalfspacing}
438 \\newcommand{\\kerneldocCJKoff}{\\makexeCJKinactive\\singlespacing}
e291ff6f
AY
439 \\newcommand{\\kerneldocBeginSC}{%
440 \\begingroup%
441 \\scmain%
442 }
443 \\newcommand{\\kerneldocEndSC}{\\endgroup}
444 \\newcommand{\\kerneldocBeginTC}{%
445 \\begingroup%
446 \\tcmain%
7eb368cc 447 \\renewcommand{\\CJKrmdefault}{TCserif}%
e291ff6f
AY
448 \\renewcommand{\\CJKsfdefault}{TCsans}%
449 \\renewcommand{\\CJKttdefault}{TCmono}%
450 }
451 \\newcommand{\\kerneldocEndTC}{\\endgroup}
452 \\newcommand{\\kerneldocBeginKR}{%
453 \\begingroup%
29ac9822
AY
454 \\xeCJKDeclareCharClass{HalfLeft}{`“,`‘}%
455 \\xeCJKDeclareCharClass{HalfRight}{`”,`’}%
e291ff6f 456 \\krmain%
7eb368cc 457 \\renewcommand{\\CJKrmdefault}{KRserif}%
e291ff6f
AY
458 \\renewcommand{\\CJKsfdefault}{KRsans}%
459 \\renewcommand{\\CJKttdefault}{KRmono}%
35382965 460 \\xeCJKsetup{CJKspace = true} % For inter-phrase space
e291ff6f
AY
461 }
462 \\newcommand{\\kerneldocEndKR}{\\endgroup}
463 \\newcommand{\\kerneldocBeginJP}{%
464 \\begingroup%
29ac9822
AY
465 \\xeCJKDeclareCharClass{HalfLeft}{`“,`‘}%
466 \\xeCJKDeclareCharClass{HalfRight}{`”,`’}%
e291ff6f 467 \\jpmain%
7eb368cc 468 \\renewcommand{\\CJKrmdefault}{JPserif}%
e291ff6f
AY
469 \\renewcommand{\\CJKsfdefault}{JPsans}%
470 \\renewcommand{\\CJKttdefault}{JPmono}%
471 }
472 \\newcommand{\\kerneldocEndJP}{\\endgroup}
77abc2c2
AY
473 % Single spacing in literal blocks
474 \\fvset{baselinestretch=1}
e291ff6f 475 % To customize \\sphinxtableofcontents
f7ebe6b7
AY
476 \\usepackage{etoolbox}
477 % Inactivate CJK after tableofcontents
478 \\apptocmd{\\sphinxtableofcontents}{\\kerneldocCJKoff}{}{}
659653c9 479 }{ % No CJK font found
f7ebe6b7
AY
480 % Custom macros to on/off CJK (Dummy)
481 \\newcommand{\\kerneldocCJKon}{}
482 \\newcommand{\\kerneldocCJKoff}{}
e291ff6f
AY
483 \\newcommand{\\kerneldocBeginSC}{}
484 \\newcommand{\\kerneldocEndSC}{}
485 \\newcommand{\\kerneldocBeginTC}{}
486 \\newcommand{\\kerneldocEndTC}{}
487 \\newcommand{\\kerneldocBeginKR}{}
488 \\newcommand{\\kerneldocEndKR}{}
7c5c18bd
AY
489 \\newcommand{\\kerneldocBeginJP}{}
490 \\newcommand{\\kerneldocEndJP}{}
659653c9
AY
491 }
492'''
9fdcd6af
MCC
493
494# Fix reference escape troubles with Sphinx 1.4.x
f546ff0c 495if major == 1:
9fdcd6af
MCC
496 latex_elements['preamble'] += '\\renewcommand*{\\DUrole}[2]{ #2 }\n'
497
9fdcd6af
MCC
498# With Sphinx 1.6, it is possible to change the Bg color directly
499# by using:
500# \definecolor{sphinxnoteBgColor}{RGB}{204,255,255}
501# \definecolor{sphinxwarningBgColor}{RGB}{255,204,204}
502# \definecolor{sphinxattentionBgColor}{RGB}{255,255,204}
503# \definecolor{sphinximportantBgColor}{RGB}{192,255,204}
504#
505# However, it require to use sphinx heavy box with:
506#
507# \renewenvironment{sphinxlightbox} {%
508# \\begin{sphinxheavybox}
509# }
510# \\end{sphinxheavybox}
511# }
512#
513# Unfortunately, the implementation is buggy: if a note is inside a
514# table, it isn't displayed well. So, for now, let's use boring
515# black and white notes.
633d612b 516
22cba31b
JN
517# Grouping the document tree into LaTeX files. List of tuples
518# (source start file, target name, title,
519# author, documentclass [howto, manual, or own class]).
c2b563d8 520# Sorted in alphabetical order
22cba31b 521latex_documents = [
22cba31b
JN
522]
523
9d42afbe
MCC
524# Add all other index files from Documentation/ subdirectories
525for fn in os.listdir('.'):
526 doc = os.path.join(fn, "index")
527 if os.path.exists(doc + ".rst"):
528 has = False
529 for l in latex_documents:
530 if l[0] == doc:
531 has = True
532 break
533 if not has:
534 latex_documents.append((doc, fn + '.tex',
535 'Linux %s Documentation' % fn.capitalize(),
536 'The kernel development community',
537 'manual'))
538
22cba31b
JN
539# The name of an image file (relative to this directory) to place at the top of
540# the title page.
541#latex_logo = None
542
543# For "manual" documents, if this is true, then toplevel headings are parts,
544# not chapters.
545#latex_use_parts = False
546
547# If true, show page references after internal links.
548#latex_show_pagerefs = False
549
550# If true, show URL addresses after external links.
551#latex_show_urls = False
552
553# Documents to append as an appendix to all manuals.
554#latex_appendices = []
555
556# If false, no module index is generated.
557#latex_domain_indices = True
558
559
560# -- Options for manual page output ---------------------------------------
561
562# One entry per manual page. List of tuples
563# (source start file, name, description, authors, manual section).
564man_pages = [
565 (master_doc, 'thelinuxkernel', 'The Linux Kernel Documentation',
566 [author], 1)
567]
568
569# If true, show URL addresses after external links.
570#man_show_urls = False
571
572
573# -- Options for Texinfo output -------------------------------------------
574
575# Grouping the document tree into Texinfo files. List of tuples
576# (source start file, target name, title, author,
577# dir menu entry, description, category)
578texinfo_documents = [
579 (master_doc, 'TheLinuxKernel', 'The Linux Kernel Documentation',
580 author, 'TheLinuxKernel', 'One line description of project.',
581 'Miscellaneous'),
582]
583
584# Documents to append as an appendix to all manuals.
585#texinfo_appendices = []
586
587# If false, no module index is generated.
588#texinfo_domain_indices = True
589
590# How to display URL addresses: 'footnote', 'no', or 'inline'.
591#texinfo_show_urls = 'footnote'
592
593# If true, do not generate a @detailmenu in the "Top" node's menu.
594#texinfo_no_detailmenu = False
595
596
597# -- Options for Epub output ----------------------------------------------
598
599# Bibliographic Dublin Core info.
600epub_title = project
601epub_author = author
602epub_publisher = author
603epub_copyright = copyright
604
605# The basename for the epub file. It defaults to the project name.
606#epub_basename = project
607
608# The HTML theme for the epub output. Since the default themes are not
609# optimized for small screen space, using the same theme for HTML and epub
610# output is usually not wise. This defaults to 'epub', a theme designed to save
611# visual space.
612#epub_theme = 'epub'
613
614# The language of the text. It defaults to the language option
615# or 'en' if the language is not set.
616#epub_language = ''
617
618# The scheme of the identifier. Typical schemes are ISBN or URL.
619#epub_scheme = ''
620
621# The unique identifier of the text. This can be a ISBN number
622# or the project homepage.
623#epub_identifier = ''
624
625# A unique identification for the text.
626#epub_uid = ''
627
628# A tuple containing the cover image and cover page html template filenames.
629#epub_cover = ()
630
631# A sequence of (type, uri, title) tuples for the guide element of content.opf.
632#epub_guide = ()
633
634# HTML files that should be inserted before the pages created by sphinx.
635# The format is a list of tuples containing the path and title.
636#epub_pre_files = []
637
638# HTML files that should be inserted after the pages created by sphinx.
639# The format is a list of tuples containing the path and title.
640#epub_post_files = []
641
642# A list of files that should not be packed into the epub file.
643epub_exclude_files = ['search.html']
644
645# The depth of the table of contents in toc.ncx.
646#epub_tocdepth = 3
647
648# Allow duplicate toc entries.
649#epub_tocdup = True
650
651# Choose between 'default' and 'includehidden'.
652#epub_tocscope = 'default'
653
654# Fix unsupported image types using the Pillow.
655#epub_fix_images = False
656
657# Scale large images.
658#epub_max_image_width = 0
659
660# How to display URL addresses: 'footnote', 'no', or 'inline'.
661#epub_show_urls = 'inline'
662
663# If false, no index is generated.
664#epub_use_index = True
665
666#=======
667# rst2pdf
668#
669# Grouping the document tree into PDF files. List of tuples
670# (source start file, target name, title, author, options).
671#
93431e06 672# See the Sphinx chapter of https://ralsina.me/static/manual.pdf
22cba31b
JN
673#
674# FIXME: Do not add the index file here; the result will be too big. Adding
675# multiple PDF files here actually tries to get the cross-referencing right
676# *between* PDF files.
677pdf_documents = [
520a2477 678 ('kernel-documentation', u'Kernel', u'Kernel', u'J. Random Bozo'),
22cba31b 679]
24dcdeb2
JN
680
681# kernel-doc extension configuration for running Sphinx directly (e.g. by Read
682# the Docs). In a normal build, these are supplied from the Makefile via command
683# line arguments.
684kerneldoc_bin = '../scripts/kernel-doc'
685kerneldoc_srctree = '..'
606b9ac8
MH
686
687# ------------------------------------------------------------------------------
688# Since loadConfig overwrites settings from the global namespace, it has to be
689# the last statement in the conf.py file
690# ------------------------------------------------------------------------------
691loadConfig(globals())