Blame view

Documentation/conf.py 21.9 KB
22cba31ba   Jani Nikula   Documentation/sph...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
  # -*- coding: utf-8 -*-
  #
  # The Linux Kernel documentation build configuration file, created by
  # sphinx-quickstart on Fri Feb 12 13:51:46 2016.
  #
  # This file is execfile()d with the current directory set to its
  # containing dir.
  #
  # Note that not all possible configuration values are present in this
  # autogenerated file.
  #
  # All configuration values have a default; values that are commented out
  # serve to show the default.
  
  import sys
  import os
d4fe7e14e   Mauro Carvalho Chehab   docs-rst: enable ...
17
18
19
  import sphinx
  
  # Get Sphinx version
c46988aef   Rémy Léone   Use sphinx.versio...
20
  major, minor, patch = sphinx.version_info[:3]
d4fe7e14e   Mauro Carvalho Chehab   docs-rst: enable ...
21

22cba31ba   Jani Nikula   Documentation/sph...
22
23
24
25
  
  # If extensions (or modules to document with autodoc) are in another directory,
  # add these directories to sys.path here. If the directory is relative to the
  # documentation root, use os.path.abspath to make it absolute, like shown here.
24dcdeb28   Jani Nikula   Documentation/sph...
26
  sys.path.insert(0, os.path.abspath('sphinx'))
606b9ac81   Markus Heiser   doc-rst: generic ...
27
  from load_config import loadConfig
22cba31ba   Jani Nikula   Documentation/sph...
28
29
30
31
  
  # -- General configuration ------------------------------------------------
  
  # If your documentation needs a minimal Sphinx version, state it here.
f546ff0c0   Jonathan Corbet   Move our minimum ...
32
  needs_sphinx = '1.7'
22cba31ba   Jani Nikula   Documentation/sph...
33
34
35
36
  
  # Add any Sphinx extension module names here, as strings. They can be
  # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
  # ones.
afde706af   Jonathan Corbet   Make the docs bui...
37
  extensions = ['kerneldoc', 'rstFlatTable', 'kernel_include',
aa2048552   Kees Cook   doc-rst: Programm...
38
                'kfigure', 'sphinx.ext.ifconfig', 'automarkup',
a7ee04b3e   Mauro Carvalho Chehab   docs: add ABI doc...
39
                'maintainers_include', 'sphinx.ext.autosectionlabel',
63fdc4625   Mauro Carvalho Chehab   docs: admin-guide...
40
                'kernel_abi', 'kernel_feat']
22cba31ba   Jani Nikula   Documentation/sph...
41

afde706af   Jonathan Corbet   Make the docs bui...
42
  if major >= 3:
d29f34c09   Mauro Carvalho Chehab   sphinx: conf.py: ...
43
      if (major > 3) or (minor > 0 or patch >= 2):
b34b86d7a   Mauro Carvalho Chehab   docs: conf.py: fi...
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
          # Sphinx c function parser is more pedantic with regards to type
          # checking. Due to that, having macros at c:function cause problems.
          # Those needed to be scaped by using c_id_attributes[] array
          c_id_attributes = [
              # GCC Compiler types not parsed by Sphinx:
              "__restrict__",
  
              # include/linux/compiler_types.h:
              "__iomem",
              "__kernel",
              "noinstr",
              "notrace",
              "__percpu",
              "__rcu",
              "__user",
  
              # include/linux/compiler_attributes.h:
              "__alias",
              "__aligned",
              "__aligned_largest",
              "__always_inline",
              "__assume_aligned",
              "__cold",
              "__attribute_const__",
              "__copy",
              "__pure",
              "__designated_init",
              "__visible",
              "__printf",
              "__scanf",
              "__gnu_inline",
              "__malloc",
              "__mode",
              "__no_caller_saved_registers",
              "__noclone",
              "__nonstring",
              "__noreturn",
              "__packed",
              "__pure",
              "__section",
              "__always_unused",
              "__maybe_unused",
              "__used",
              "__weak",
              "noinline",
  
              # include/linux/memblock.h:
              "__init_memblock",
              "__meminit",
  
              # include/linux/init.h:
              "__init",
              "__ref",
  
              # include/linux/linkage.h:
              "asmlinkage",
          ]
afde706af   Jonathan Corbet   Make the docs bui...
101
102
  else:
      extensions.append('cdomain')
4658b0eb9   Mauro Carvalho Chehab   docs: conf.py: av...
103
104
105
  # Ensure that autosectionlabel will produce unique names
  autosectionlabel_prefix_document = True
  autosectionlabel_maxdepth = 2
f546ff0c0   Jonathan Corbet   Move our minimum ...
106
  extensions.append("sphinx.ext.imgmath")
22cba31ba   Jani Nikula   Documentation/sph...
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
  
  # Add any paths that contain templates here, relative to this directory.
  templates_path = ['_templates']
  
  # The suffix(es) of source filenames.
  # You can specify multiple suffix as a list of string:
  # source_suffix = ['.rst', '.md']
  source_suffix = '.rst'
  
  # The encoding of source files.
  #source_encoding = 'utf-8-sig'
  
  # The master toctree document.
  master_doc = 'index'
  
  # General information about the project.
  project = 'The Linux Kernel'
dc36143fb   Jonathan Corbet   docs: Remove the ...
124
  copyright = 'The kernel development community'
22cba31ba   Jani Nikula   Documentation/sph...
125
126
127
128
129
130
  author = 'The kernel development community'
  
  # The version info for the project you're documenting, acts as replacement for
  # |version| and |release|, also used in various other places throughout the
  # built documents.
  #
c13ce448c   Jani Nikula   Documentation/sph...
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
  # In a normal build, version and release are are set to KERNELVERSION and
  # KERNELRELEASE, respectively, from the Makefile via Sphinx command line
  # arguments.
  #
  # The following code tries to extract the information by reading the Makefile,
  # when Sphinx is run directly (e.g. by Read the Docs).
  try:
      makefile_version = None
      makefile_patchlevel = None
      for line in open('../Makefile'):
          key, val = [x.strip() for x in line.split('=', 2)]
          if key == 'VERSION':
              makefile_version = val
          elif key == 'PATCHLEVEL':
              makefile_patchlevel = val
          if makefile_version and makefile_patchlevel:
              break
  except:
      pass
  finally:
      if makefile_version and makefile_patchlevel:
          version = release = makefile_version + '.' + makefile_patchlevel
      else:
c13ce448c   Jani Nikula   Documentation/sph...
154
          version = release = "unknown version"
22cba31ba   Jani Nikula   Documentation/sph...
155
156
157
158
159
160
  
  # The language for content autogenerated by Sphinx. Refer to documentation
  # for a list of supported languages.
  #
  # This is also used if you do content translation via gettext catalogs.
  # Usually you set "language" from the command line for these cases.
5b726ed6a   Akira Yokosawa   docs/conf.py: Cop...
161
  language = 'en'
22cba31ba   Jani Nikula   Documentation/sph...
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
  
  # There are two options for replacing |today|: either, you set today to some
  # non-false value, then it is used:
  #today = ''
  # Else, today_fmt is used as the format for a strftime call.
  #today_fmt = '%B %d, %Y'
  
  # List of patterns, relative to source directory, that match files and
  # directories to ignore when looking for source files.
  exclude_patterns = ['output']
  
  # The reST default role (used for this markup: `text`) to use for all
  # documents.
  #default_role = None
  
  # If true, '()' will be appended to :func: etc. cross-reference text.
  #add_function_parentheses = True
  
  # If true, the current module name will be prepended to all description
  # unit titles (such as .. function::).
  #add_module_names = True
  
  # If true, sectionauthor and moduleauthor directives will be shown in the
  # output. They are ignored by default.
  #show_authors = False
  
  # The name of the Pygments (syntax highlighting) style to use.
  pygments_style = 'sphinx'
  
  # A list of ignored prefixes for module index sorting.
  #modindex_common_prefix = []
  
  # If true, keep warnings as "system message" paragraphs in the built documents.
  #keep_warnings = False
  
  # If true, `todo` and `todoList` produce output, else they produce nothing.
  todo_include_todos = False
fd5d66693   John Keeping   Documentation/sph...
199
  primary_domain = 'c'
b459106ea   Jani Nikula   Documentation/sph...
200
  highlight_language = 'none'
22cba31ba   Jani Nikula   Documentation/sph...
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
  
  # -- Options for HTML output ----------------------------------------------
  
  # The theme to use for HTML and HTML Help pages.  See the documentation for
  # a list of builtin themes.
  
  # The Read the Docs theme is available from
  # - https://github.com/snide/sphinx_rtd_theme
  # - https://pypi.python.org/pypi/sphinx_rtd_theme
  # - python-sphinx-rtd-theme package (on Debian)
  try:
      import sphinx_rtd_theme
      html_theme = 'sphinx_rtd_theme'
      html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
  except ImportError:
      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.
  ')
  
  # Theme options are theme-specific and customize the look and feel of a theme
  # further.  For a list of options available for each theme, see the
  # documentation.
  #html_theme_options = {}
  
  # Add any paths that contain custom themes here, relative to this directory.
  #html_theme_path = []
  
  # The name for this set of Sphinx documents.  If None, it defaults to
  # "<project> v<release> documentation".
  #html_title = None
  
  # A shorter title for the navigation bar.  Default is the same as html_title.
  #html_short_title = None
  
  # The name of an image file (relative to this directory) to place at the top
  # of the sidebar.
  #html_logo = None
  
  # The name of an image file (within the static path) to use as favicon of the
  # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
  # pixels large.
  #html_favicon = None
  
  # Add any paths that contain custom static files (such as style sheets) here,
  # relative to this directory. They are copied after the builtin static files,
  # so a file named "default.css" will overwrite the builtin "default.css".
bc2146711   Markus Heiser   doc-rst: boilerpl...
246
247
248
249
250
251
252
253
  
  html_static_path = ['sphinx-static']
  
  html_context = {
      'css_files': [
          '_static/theme_overrides.css',
      ],
  }
22cba31ba   Jani Nikula   Documentation/sph...
254
255
256
257
258
259
260
261
262
263
264
265
  
  # Add any extra paths that contain custom files (such as robots.txt or
  # .htaccess) here, relative to this directory. These files are copied
  # directly to the root of the documentation.
  #html_extra_path = []
  
  # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
  # using the given strftime format.
  #html_last_updated_fmt = '%b %d, %Y'
  
  # If true, SmartyPants will be used to convert quotes and dashes to
  # typographically correct entities.
7282a93f4   Stephen Kitt   Disable Sphinx Sm...
266
  html_use_smartypants = False
22cba31ba   Jani Nikula   Documentation/sph...
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
  
  # Custom sidebar templates, maps document names to template names.
  #html_sidebars = {}
  
  # Additional templates that should be rendered to pages, maps page names to
  # template names.
  #html_additional_pages = {}
  
  # If false, no module index is generated.
  #html_domain_indices = True
  
  # If false, no index is generated.
  #html_use_index = True
  
  # If true, the index is split into individual pages for each letter.
  #html_split_index = False
  
  # If true, links to the reST sources are added to the pages.
  #html_show_sourcelink = True
  
  # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
  #html_show_sphinx = True
  
  # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
  #html_show_copyright = True
  
  # If true, an OpenSearch description file will be output, and all pages will
  # contain a <link> tag referring to it.  The value of this option must be the
  # base URL from which the finished HTML is served.
  #html_use_opensearch = ''
  
  # This is the file name suffix for HTML files (e.g. ".xhtml").
  #html_file_suffix = None
  
  # Language to be used for generating the HTML full-text search index.
  # Sphinx supports the following languages:
  #   'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja'
  #   'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr'
  #html_search_language = 'en'
  
  # A dictionary with options for the search language support, empty by default.
  # Now only 'ja' uses this config value
  #html_search_options = {'type': 'default'}
  
  # The name of a javascript file (relative to the configuration directory) that
  # implements a search results scorer. If empty, the default will be used.
  #html_search_scorer = 'scorer.js'
  
  # Output file base name for HTML help builder.
  htmlhelp_basename = 'TheLinuxKerneldoc'
  
  # -- Options for LaTeX output ---------------------------------------------
  
  latex_elements = {
3b4c96324   Mauro Carvalho Chehab   docs: conf.py: ad...
321
322
      # The paper size ('letterpaper' or 'a4paper').
      'papersize': 'a4paper',
22cba31ba   Jani Nikula   Documentation/sph...
323

3b4c96324   Mauro Carvalho Chehab   docs: conf.py: ad...
324
325
      # The font size ('10pt', '11pt' or '12pt').
      'pointsize': '11pt',
22cba31ba   Jani Nikula   Documentation/sph...
326

3b4c96324   Mauro Carvalho Chehab   docs: conf.py: ad...
327
328
      # Latex figure (float) alignment
      #'figure_align': 'htbp',
caee5cded   Mauro Carvalho Chehab   docs-rst: allow g...
329

3b4c96324   Mauro Carvalho Chehab   docs: conf.py: ad...
330
331
332
      # Don't mangle with UTF-8 chars
      'inputenc': '',
      'utf8extra': '',
a682ec4ba   Mauro Carvalho Chehab   docs-rst: Don't m...
333

3b4c96324   Mauro Carvalho Chehab   docs: conf.py: ad...
334
335
336
337
338
339
      # Set document margins
      'sphinxsetup': '''
          hmargin=0.5in, vmargin=1in,
          parsedliteralwraps=true,
          verbatimhintsturnover=false,
      ''',
77abc2c23   Akira Yokosawa   docs: pdfdocs: On...
340
341
      # For CJK One-half spacing, need to be in front of hyperref
      'extrapackages': r'\usepackage{setspace}',
3b4c96324   Mauro Carvalho Chehab   docs: conf.py: ad...
342
      # Additional stuff for the LaTeX preamble.
caee5cded   Mauro Carvalho Chehab   docs-rst: allow g...
343
      'preamble': '''
0afd4df0d   Akira Yokosawa   docs: pdfdocs: Pr...
344
345
  	% Prevent column squeezing of tabulary.
  	\\setlength{\\tymin}{20em}
3b4c96324   Mauro Carvalho Chehab   docs: conf.py: ad...
346
          % Use some font with UTF-8 support with XeLaTeX
9fdcd6afd   Mauro Carvalho Chehab   docs-rst: conf.py...
347
          \\usepackage{fontspec}
44ba0bb4f   Darrick J. Wong   docs: improve rea...
348
349
          \\setsansfont{DejaVu Sans}
          \\setromanfont{DejaVu Serif}
9fdcd6afd   Mauro Carvalho Chehab   docs-rst: conf.py...
350
          \\setmonofont{DejaVu Sans Mono}
3b4c96324   Mauro Carvalho Chehab   docs: conf.py: ad...
351
       ''',
e0de2b59e   Mauro Carvalho Chehab   docs: conf.py: on...
352
  }
9fdcd6afd   Mauro Carvalho Chehab   docs-rst: conf.py...
353

659653c9e   Akira Yokosawa   docs: pdfdocs: Re...
354
355
  # Translations have Asian (CJK) characters which are only displayed if
  # xeCJK is used
e0de2b59e   Mauro Carvalho Chehab   docs: conf.py: on...
356

659653c9e   Akira Yokosawa   docs: pdfdocs: Re...
357
358
  latex_elements['preamble']  += '''
      \\IfFontExistsTF{Noto Sans CJK SC}{
24889dad3   Mauro Carvalho Chehab   docs: conf.py: ad...
359
  	% This is needed for translations
659653c9e   Akira Yokosawa   docs: pdfdocs: Re...
360
  	\\usepackage{xeCJK}
7eb368cc3   Akira Yokosawa   docs: pdfdocs: Ch...
361
  	\\IfFontExistsTF{Noto Serif CJK SC}{
788d28a25   Akira Yokosawa   docs: pdfdocs: Pe...
362
  	    \\setCJKmainfont{Noto Serif CJK SC}[AutoFakeSlant]
7eb368cc3   Akira Yokosawa   docs: pdfdocs: Ch...
363
  	}{
788d28a25   Akira Yokosawa   docs: pdfdocs: Pe...
364
  	    \\setCJKmainfont{Noto Sans CJK SC}[AutoFakeSlant]
7eb368cc3   Akira Yokosawa   docs: pdfdocs: Ch...
365
  	}
788d28a25   Akira Yokosawa   docs: pdfdocs: Pe...
366
367
  	\\setCJKsansfont{Noto Sans CJK SC}[AutoFakeSlant]
  	\\setCJKmonofont{Noto Sans Mono CJK SC}[AutoFakeSlant]
e291ff6f5   Akira Yokosawa   docs: pdfdocs: Ad...
368
  	% CJK Language-specific font choices
7eb368cc3   Akira Yokosawa   docs: pdfdocs: Ch...
369
  	\\IfFontExistsTF{Noto Serif CJK SC}{
788d28a25   Akira Yokosawa   docs: pdfdocs: Pe...
370
371
372
373
  	    \
  ewCJKfontfamily[SCmain]\\scmain{Noto Serif CJK SC}[AutoFakeSlant]
  	    \
  ewCJKfontfamily[SCserif]\\scserif{Noto Serif CJK SC}[AutoFakeSlant]
7eb368cc3   Akira Yokosawa   docs: pdfdocs: Ch...
374
  	}{
788d28a25   Akira Yokosawa   docs: pdfdocs: Pe...
375
376
377
378
  	    \
  ewCJKfontfamily[SCmain]\\scmain{Noto Sans CJK SC}[AutoFakeSlant]
  	    \
  ewCJKfontfamily[SCserif]\\scserif{Noto Sans CJK SC}[AutoFakeSlant]
7eb368cc3   Akira Yokosawa   docs: pdfdocs: Ch...
379
  	}
788d28a25   Akira Yokosawa   docs: pdfdocs: Pe...
380
381
382
383
  	\
  ewCJKfontfamily[SCsans]\\scsans{Noto Sans CJK SC}[AutoFakeSlant]
  	\
  ewCJKfontfamily[SCmono]\\scmono{Noto Sans Mono CJK SC}[AutoFakeSlant]
7eb368cc3   Akira Yokosawa   docs: pdfdocs: Ch...
384
  	\\IfFontExistsTF{Noto Serif CJK TC}{
788d28a25   Akira Yokosawa   docs: pdfdocs: Pe...
385
386
387
388
  	    \
  ewCJKfontfamily[TCmain]\\tcmain{Noto Serif CJK TC}[AutoFakeSlant]
  	    \
  ewCJKfontfamily[TCserif]\\tcserif{Noto Serif CJK TC}[AutoFakeSlant]
7eb368cc3   Akira Yokosawa   docs: pdfdocs: Ch...
389
  	}{
788d28a25   Akira Yokosawa   docs: pdfdocs: Pe...
390
391
392
393
  	    \
  ewCJKfontfamily[TCmain]\\tcmain{Noto Sans CJK TC}[AutoFakeSlant]
  	    \
  ewCJKfontfamily[TCserif]\\tcserif{Noto Sans CJK TC}[AutoFakeSlant]
7eb368cc3   Akira Yokosawa   docs: pdfdocs: Ch...
394
  	}
788d28a25   Akira Yokosawa   docs: pdfdocs: Pe...
395
396
397
398
  	\
  ewCJKfontfamily[TCsans]\\tcsans{Noto Sans CJK TC}[AutoFakeSlant]
  	\
  ewCJKfontfamily[TCmono]\\tcmono{Noto Sans Mono CJK TC}[AutoFakeSlant]
7eb368cc3   Akira Yokosawa   docs: pdfdocs: Ch...
399
  	\\IfFontExistsTF{Noto Serif CJK KR}{
788d28a25   Akira Yokosawa   docs: pdfdocs: Pe...
400
401
402
403
  	    \
  ewCJKfontfamily[KRmain]\\krmain{Noto Serif CJK KR}[AutoFakeSlant]
  	    \
  ewCJKfontfamily[KRserif]\\krserif{Noto Serif CJK KR}[AutoFakeSlant]
7eb368cc3   Akira Yokosawa   docs: pdfdocs: Ch...
404
  	}{
788d28a25   Akira Yokosawa   docs: pdfdocs: Pe...
405
406
407
408
  	    \
  ewCJKfontfamily[KRmain]\\krmain{Noto Sans CJK KR}[AutoFakeSlant]
  	    \
  ewCJKfontfamily[KRserif]\\krserif{Noto Sans CJK KR}[AutoFakeSlant]
7eb368cc3   Akira Yokosawa   docs: pdfdocs: Ch...
409
  	}
788d28a25   Akira Yokosawa   docs: pdfdocs: Pe...
410
411
412
413
  	\
  ewCJKfontfamily[KRsans]\\krsans{Noto Sans CJK KR}[AutoFakeSlant]
  	\
  ewCJKfontfamily[KRmono]\\krmono{Noto Sans Mono CJK KR}[AutoFakeSlant]
7eb368cc3   Akira Yokosawa   docs: pdfdocs: Ch...
414
  	\\IfFontExistsTF{Noto Serif CJK JP}{
788d28a25   Akira Yokosawa   docs: pdfdocs: Pe...
415
416
417
418
  	    \
  ewCJKfontfamily[JPmain]\\jpmain{Noto Serif CJK JP}[AutoFakeSlant]
  	    \
  ewCJKfontfamily[JPserif]\\jpserif{Noto Serif CJK JP}[AutoFakeSlant]
7eb368cc3   Akira Yokosawa   docs: pdfdocs: Ch...
419
  	}{
788d28a25   Akira Yokosawa   docs: pdfdocs: Pe...
420
421
422
423
  	    \
  ewCJKfontfamily[JPmain]\\jpmain{Noto Sans CJK JP}[AutoFakeSlant]
  	    \
  ewCJKfontfamily[JPserif]\\jpserif{Noto Sans CJK JP}[AutoFakeSlant]
7eb368cc3   Akira Yokosawa   docs: pdfdocs: Ch...
424
  	}
788d28a25   Akira Yokosawa   docs: pdfdocs: Pe...
425
426
427
428
  	\
  ewCJKfontfamily[JPsans]\\jpsans{Noto Sans CJK JP}[AutoFakeSlant]
  	\
  ewCJKfontfamily[JPmono]\\jpmono{Noto Sans Mono CJK JP}[AutoFakeSlant]
77abc2c23   Akira Yokosawa   docs: pdfdocs: On...
429
430
431
  	% Dummy commands for Sphinx < 2.3 (no 'extrapackages' support)
  	\\providecommand{\\onehalfspacing}{}
  	\\providecommand{\\singlespacing}{}
f7ebe6b76   Akira Yokosawa   docs: Activate ex...
432
  	% Define custom macros to on/off CJK
77abc2c23   Akira Yokosawa   docs: pdfdocs: On...
433
434
435
436
  	\
  ewcommand{\\kerneldocCJKon}{\\makexeCJKactive\\onehalfspacing}
  	\
  ewcommand{\\kerneldocCJKoff}{\\makexeCJKinactive\\singlespacing}
e291ff6f5   Akira Yokosawa   docs: pdfdocs: Ad...
437
438
439
440
441
442
443
444
445
446
447
  	\
  ewcommand{\\kerneldocBeginSC}{%
  	    \\begingroup%
  	    \\scmain%
  	}
  	\
  ewcommand{\\kerneldocEndSC}{\\endgroup}
  	\
  ewcommand{\\kerneldocBeginTC}{%
  	    \\begingroup%
  	    \\tcmain%
7eb368cc3   Akira Yokosawa   docs: pdfdocs: Ch...
448
  	    \\renewcommand{\\CJKrmdefault}{TCserif}%
e291ff6f5   Akira Yokosawa   docs: pdfdocs: Ad...
449
450
451
452
453
454
455
456
  	    \\renewcommand{\\CJKsfdefault}{TCsans}%
  	    \\renewcommand{\\CJKttdefault}{TCmono}%
  	}
  	\
  ewcommand{\\kerneldocEndTC}{\\endgroup}
  	\
  ewcommand{\\kerneldocBeginKR}{%
  	    \\begingroup%
29ac98223   Akira Yokosawa   docs: pdfdocs: Te...
457
458
  	    \\xeCJKDeclareCharClass{HalfLeft}{`“,`‘}%
  	    \\xeCJKDeclareCharClass{HalfRight}{`”,`’}%
e291ff6f5   Akira Yokosawa   docs: pdfdocs: Ad...
459
  	    \\krmain%
7eb368cc3   Akira Yokosawa   docs: pdfdocs: Ch...
460
  	    \\renewcommand{\\CJKrmdefault}{KRserif}%
e291ff6f5   Akira Yokosawa   docs: pdfdocs: Ad...
461
462
  	    \\renewcommand{\\CJKsfdefault}{KRsans}%
  	    \\renewcommand{\\CJKttdefault}{KRmono}%
35382965b   Akira Yokosawa   docs: pdfdocs: Pr...
463
  	    \\xeCJKsetup{CJKspace = true} % For inter-phrase space
e291ff6f5   Akira Yokosawa   docs: pdfdocs: Ad...
464
465
466
467
468
469
  	}
  	\
  ewcommand{\\kerneldocEndKR}{\\endgroup}
  	\
  ewcommand{\\kerneldocBeginJP}{%
  	    \\begingroup%
29ac98223   Akira Yokosawa   docs: pdfdocs: Te...
470
471
  	    \\xeCJKDeclareCharClass{HalfLeft}{`“,`‘}%
  	    \\xeCJKDeclareCharClass{HalfRight}{`”,`’}%
e291ff6f5   Akira Yokosawa   docs: pdfdocs: Ad...
472
  	    \\jpmain%
7eb368cc3   Akira Yokosawa   docs: pdfdocs: Ch...
473
  	    \\renewcommand{\\CJKrmdefault}{JPserif}%
e291ff6f5   Akira Yokosawa   docs: pdfdocs: Ad...
474
475
476
477
478
  	    \\renewcommand{\\CJKsfdefault}{JPsans}%
  	    \\renewcommand{\\CJKttdefault}{JPmono}%
  	}
  	\
  ewcommand{\\kerneldocEndJP}{\\endgroup}
77abc2c23   Akira Yokosawa   docs: pdfdocs: On...
479
480
  	% Single spacing in literal blocks
  	\\fvset{baselinestretch=1}
e291ff6f5   Akira Yokosawa   docs: pdfdocs: Ad...
481
  	% To customize \\sphinxtableofcontents
f7ebe6b76   Akira Yokosawa   docs: Activate ex...
482
483
484
  	\\usepackage{etoolbox}
  	% Inactivate CJK after tableofcontents
  	\\apptocmd{\\sphinxtableofcontents}{\\kerneldocCJKoff}{}{}
659653c9e   Akira Yokosawa   docs: pdfdocs: Re...
485
      }{ % No CJK font found
f7ebe6b76   Akira Yokosawa   docs: Activate ex...
486
487
488
489
490
  	% Custom macros to on/off CJK (Dummy)
  	\
  ewcommand{\\kerneldocCJKon}{}
  	\
  ewcommand{\\kerneldocCJKoff}{}
e291ff6f5   Akira Yokosawa   docs: pdfdocs: Ad...
491
492
493
494
495
496
497
498
499
500
501
502
  	\
  ewcommand{\\kerneldocBeginSC}{}
  	\
  ewcommand{\\kerneldocEndSC}{}
  	\
  ewcommand{\\kerneldocBeginTC}{}
  	\
  ewcommand{\\kerneldocEndTC}{}
  	\
  ewcommand{\\kerneldocBeginKR}{}
  	\
  ewcommand{\\kerneldocEndKR}{}
7c5c18bdb   Akira Yokosawa   docs: pdfdocs: Fi...
503
504
505
506
  	\
  ewcommand{\\kerneldocBeginJP}{}
  	\
  ewcommand{\\kerneldocEndJP}{}
659653c9e   Akira Yokosawa   docs: pdfdocs: Re...
507
508
      }
  '''
9fdcd6afd   Mauro Carvalho Chehab   docs-rst: conf.py...
509
510
  
  # Fix reference escape troubles with Sphinx 1.4.x
f546ff0c0   Jonathan Corbet   Move our minimum ...
511
  if major == 1:
9fdcd6afd   Mauro Carvalho Chehab   docs-rst: conf.py...
512
513
      latex_elements['preamble']  += '\\renewcommand*{\\DUrole}[2]{ #2 }
  '
9fdcd6afd   Mauro Carvalho Chehab   docs-rst: conf.py...
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
  # With Sphinx 1.6, it is possible to change the Bg color directly
  # by using:
  #	\definecolor{sphinxnoteBgColor}{RGB}{204,255,255}
  #	\definecolor{sphinxwarningBgColor}{RGB}{255,204,204}
  #	\definecolor{sphinxattentionBgColor}{RGB}{255,255,204}
  #	\definecolor{sphinximportantBgColor}{RGB}{192,255,204}
  #
  # However, it require to use sphinx heavy box with:
  #
  #	\renewenvironment{sphinxlightbox} {%
  #		\\begin{sphinxheavybox}
  #	}
  #		\\end{sphinxheavybox}
  #	}
  #
  # Unfortunately, the implementation is buggy: if a note is inside a
  # table, it isn't displayed well. So, for now, let's use boring
  # black and white notes.
633d612bd   Mauro Carvalho Chehab   Docs: Fix breakag...
532

22cba31ba   Jani Nikula   Documentation/sph...
533
534
535
  # Grouping the document tree into LaTeX files. List of tuples
  # (source start file, target name, title,
  #  author, documentclass [howto, manual, or own class]).
c2b563d8a   Mauro Carvalho Chehab   docs-rst: conf.py...
536
  # Sorted in alphabetical order
22cba31ba   Jani Nikula   Documentation/sph...
537
  latex_documents = [
22cba31ba   Jani Nikula   Documentation/sph...
538
  ]
9d42afbe6   Mauro Carvalho Chehab   docs: pdf: add al...
539
540
541
542
543
544
545
546
547
548
549
550
551
552
  # Add all other index files from Documentation/ subdirectories
  for fn in os.listdir('.'):
      doc = os.path.join(fn, "index")
      if os.path.exists(doc + ".rst"):
          has = False
          for l in latex_documents:
              if l[0] == doc:
                  has = True
                  break
          if not has:
              latex_documents.append((doc, fn + '.tex',
                                      'Linux %s Documentation' % fn.capitalize(),
                                      'The kernel development community',
                                      'manual'))
22cba31ba   Jani Nikula   Documentation/sph...
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
  # The name of an image file (relative to this directory) to place at the top of
  # the title page.
  #latex_logo = None
  
  # For "manual" documents, if this is true, then toplevel headings are parts,
  # not chapters.
  #latex_use_parts = False
  
  # If true, show page references after internal links.
  #latex_show_pagerefs = False
  
  # If true, show URL addresses after external links.
  #latex_show_urls = False
  
  # Documents to append as an appendix to all manuals.
  #latex_appendices = []
  
  # If false, no module index is generated.
  #latex_domain_indices = True
  
  
  # -- Options for manual page output ---------------------------------------
  
  # One entry per manual page. List of tuples
  # (source start file, name, description, authors, manual section).
  man_pages = [
      (master_doc, 'thelinuxkernel', 'The Linux Kernel Documentation',
       [author], 1)
  ]
  
  # If true, show URL addresses after external links.
  #man_show_urls = False
  
  
  # -- Options for Texinfo output -------------------------------------------
  
  # Grouping the document tree into Texinfo files. List of tuples
  # (source start file, target name, title, author,
  #  dir menu entry, description, category)
  texinfo_documents = [
      (master_doc, 'TheLinuxKernel', 'The Linux Kernel Documentation',
       author, 'TheLinuxKernel', 'One line description of project.',
       'Miscellaneous'),
  ]
  
  # Documents to append as an appendix to all manuals.
  #texinfo_appendices = []
  
  # If false, no module index is generated.
  #texinfo_domain_indices = True
  
  # How to display URL addresses: 'footnote', 'no', or 'inline'.
  #texinfo_show_urls = 'footnote'
  
  # If true, do not generate a @detailmenu in the "Top" node's menu.
  #texinfo_no_detailmenu = False
  
  
  # -- Options for Epub output ----------------------------------------------
  
  # Bibliographic Dublin Core info.
  epub_title = project
  epub_author = author
  epub_publisher = author
  epub_copyright = copyright
  
  # The basename for the epub file. It defaults to the project name.
  #epub_basename = project
  
  # The HTML theme for the epub output. Since the default themes are not
  # optimized for small screen space, using the same theme for HTML and epub
  # output is usually not wise. This defaults to 'epub', a theme designed to save
  # visual space.
  #epub_theme = 'epub'
  
  # The language of the text. It defaults to the language option
  # or 'en' if the language is not set.
  #epub_language = ''
  
  # The scheme of the identifier. Typical schemes are ISBN or URL.
  #epub_scheme = ''
  
  # The unique identifier of the text. This can be a ISBN number
  # or the project homepage.
  #epub_identifier = ''
  
  # A unique identification for the text.
  #epub_uid = ''
  
  # A tuple containing the cover image and cover page html template filenames.
  #epub_cover = ()
  
  # A sequence of (type, uri, title) tuples for the guide element of content.opf.
  #epub_guide = ()
  
  # HTML files that should be inserted before the pages created by sphinx.
  # The format is a list of tuples containing the path and title.
  #epub_pre_files = []
  
  # HTML files that should be inserted after the pages created by sphinx.
  # The format is a list of tuples containing the path and title.
  #epub_post_files = []
  
  # A list of files that should not be packed into the epub file.
  epub_exclude_files = ['search.html']
  
  # The depth of the table of contents in toc.ncx.
  #epub_tocdepth = 3
  
  # Allow duplicate toc entries.
  #epub_tocdup = True
  
  # Choose between 'default' and 'includehidden'.
  #epub_tocscope = 'default'
  
  # Fix unsupported image types using the Pillow.
  #epub_fix_images = False
  
  # Scale large images.
  #epub_max_image_width = 0
  
  # How to display URL addresses: 'footnote', 'no', or 'inline'.
  #epub_show_urls = 'inline'
  
  # If false, no index is generated.
  #epub_use_index = True
  
  #=======
  # rst2pdf
  #
  # Grouping the document tree into PDF files. List of tuples
  # (source start file, target name, title, author, options).
  #
93431e060   Alexander A. Klimov   Replace HTTP link...
686
  # See the Sphinx chapter of https://ralsina.me/static/manual.pdf
22cba31ba   Jani Nikula   Documentation/sph...
687
688
689
690
691
  #
  # FIXME: Do not add the index file here; the result will be too big. Adding
  # multiple PDF files here actually tries to get the cross-referencing right
  # *between* PDF files.
  pdf_documents = [
520a24776   Mauro Carvalho Chehab   doc-rst: Fix comp...
692
      ('kernel-documentation', u'Kernel', u'Kernel', u'J. Random Bozo'),
22cba31ba   Jani Nikula   Documentation/sph...
693
  ]
24dcdeb28   Jani Nikula   Documentation/sph...
694
695
696
697
698
699
  
  # kernel-doc extension configuration for running Sphinx directly (e.g. by Read
  # the Docs). In a normal build, these are supplied from the Makefile via command
  # line arguments.
  kerneldoc_bin = '../scripts/kernel-doc'
  kerneldoc_srctree = '..'
606b9ac81   Markus Heiser   doc-rst: generic ...
700
701
702
703
704
705
  
  # ------------------------------------------------------------------------------
  # Since loadConfig overwrites settings from the global namespace, it has to be
  # the last statement in the conf.py file
  # ------------------------------------------------------------------------------
  loadConfig(globals())