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