1 # -*- coding: utf-8 -*- 1 # -*- coding: utf-8 -*-
2 # 2 #
3 # The Linux Kernel documentation build configu 3 # The Linux Kernel documentation build configuration file, created by
4 # sphinx-quickstart on Fri Feb 12 13:51:46 201 4 # sphinx-quickstart on Fri Feb 12 13:51:46 2016.
5 # 5 #
6 # This file is execfile()d with the current di 6 # This file is execfile()d with the current directory set to its
7 # containing dir. 7 # containing dir.
8 # 8 #
9 # Note that not all possible configuration val 9 # Note that not all possible configuration values are present in this
10 # autogenerated file. 10 # autogenerated file.
11 # 11 #
12 # All configuration values have a default; val 12 # All configuration values have a default; values that are commented out
13 # serve to show the default. 13 # serve to show the default.
14 14
15 import sys 15 import sys
16 import os 16 import os
17 import sphinx 17 import sphinx
18 import shutil <<
19 18
20 # helper !! 19 from subprocess import check_output
21 # ------ <<
22 <<
23 def have_command(cmd): <<
24 """Search ``cmd`` in the ``PATH`` environm <<
25 <<
26 If found, return True. <<
27 If not found, return False. <<
28 """ <<
29 return shutil.which(cmd) is not None <<
30 20
31 # Get Sphinx version 21 # Get Sphinx version
32 major, minor, patch = sphinx.version_info[:3] 22 major, minor, patch = sphinx.version_info[:3]
33 23
34 # <<
35 # Warn about older versions that we don't want <<
36 # longer. <<
37 # <<
38 if (major < 2) or (major == 2 and minor < 4): <<
39 print('WARNING: support for Sphinx < 2.4 w <<
40 24
41 # If extensions (or modules to document with a 25 # If extensions (or modules to document with autodoc) are in another directory,
42 # add these directories to sys.path here. If t 26 # add these directories to sys.path here. If the directory is relative to the
43 # documentation root, use os.path.abspath to m 27 # documentation root, use os.path.abspath to make it absolute, like shown here.
44 sys.path.insert(0, os.path.abspath('sphinx')) 28 sys.path.insert(0, os.path.abspath('sphinx'))
45 from load_config import loadConfig 29 from load_config import loadConfig
46 30
47 # -- General configuration ------------------- 31 # -- General configuration ------------------------------------------------
48 32
49 # If your documentation needs a minimal Sphinx 33 # If your documentation needs a minimal Sphinx version, state it here.
50 needs_sphinx = '2.4.4' !! 34 needs_sphinx = '1.7'
51 35
52 # Add any Sphinx extension module names here, 36 # Add any Sphinx extension module names here, as strings. They can be
53 # extensions coming with Sphinx (named 'sphinx 37 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
54 # ones. 38 # ones.
55 extensions = ['kerneldoc', 'rstFlatTable', 'ke 39 extensions = ['kerneldoc', 'rstFlatTable', 'kernel_include',
56 'kfigure', 'sphinx.ext.ifconfig' 40 'kfigure', 'sphinx.ext.ifconfig', 'automarkup',
57 'maintainers_include', 'sphinx.e 41 'maintainers_include', 'sphinx.ext.autosectionlabel',
58 'kernel_abi', 'kernel_feat', 'tr !! 42 'kernel_abi', 'kernel_feat']
59 43
>> 44 #
>> 45 # cdomain is badly broken in Sphinx 3+. Leaving it out generates *most*
>> 46 # of the docs correctly, but not all. Scream bloody murder but allow
>> 47 # the process to proceed; hopefully somebody will fix this properly soon.
>> 48 #
60 if major >= 3: 49 if major >= 3:
>> 50 sys.stderr.write('''WARNING: The kernel documentation build process
>> 51 support for Sphinx v3.0 and above is brand new. Be prepared for
>> 52 possible issues in the generated output.\n''')
61 if (major > 3) or (minor > 0 or patch >= 2 53 if (major > 3) or (minor > 0 or patch >= 2):
62 # Sphinx c function parser is more ped 54 # Sphinx c function parser is more pedantic with regards to type
63 # checking. Due to that, having macros 55 # checking. Due to that, having macros at c:function cause problems.
64 # Those needed to be scaped by using c 56 # Those needed to be scaped by using c_id_attributes[] array
65 c_id_attributes = [ 57 c_id_attributes = [
66 # GCC Compiler types not parsed by 58 # GCC Compiler types not parsed by Sphinx:
67 "__restrict__", 59 "__restrict__",
68 60
69 # include/linux/compiler_types.h: 61 # include/linux/compiler_types.h:
70 "__iomem", 62 "__iomem",
71 "__kernel", 63 "__kernel",
72 "noinstr", 64 "noinstr",
73 "notrace", 65 "notrace",
74 "__percpu", 66 "__percpu",
75 "__rcu", 67 "__rcu",
76 "__user", 68 "__user",
77 "__force", <<
78 "__counted_by_le", <<
79 "__counted_by_be", <<
80 69
81 # include/linux/compiler_attribute 70 # include/linux/compiler_attributes.h:
82 "__alias", 71 "__alias",
83 "__aligned", 72 "__aligned",
84 "__aligned_largest", 73 "__aligned_largest",
85 "__always_inline", 74 "__always_inline",
86 "__assume_aligned", 75 "__assume_aligned",
87 "__cold", 76 "__cold",
88 "__attribute_const__", 77 "__attribute_const__",
89 "__copy", 78 "__copy",
90 "__pure", 79 "__pure",
91 "__designated_init", 80 "__designated_init",
92 "__visible", 81 "__visible",
93 "__printf", 82 "__printf",
94 "__scanf", 83 "__scanf",
95 "__gnu_inline", 84 "__gnu_inline",
96 "__malloc", 85 "__malloc",
97 "__mode", 86 "__mode",
98 "__no_caller_saved_registers", 87 "__no_caller_saved_registers",
99 "__noclone", 88 "__noclone",
100 "__nonstring", 89 "__nonstring",
101 "__noreturn", 90 "__noreturn",
102 "__packed", 91 "__packed",
103 "__pure", 92 "__pure",
104 "__section", 93 "__section",
105 "__always_unused", 94 "__always_unused",
106 "__maybe_unused", 95 "__maybe_unused",
107 "__used", 96 "__used",
108 "__weak", 97 "__weak",
109 "noinline", 98 "noinline",
110 "__fix_address", <<
111 "__counted_by", <<
112 99
113 # include/linux/memblock.h: 100 # include/linux/memblock.h:
114 "__init_memblock", 101 "__init_memblock",
115 "__meminit", 102 "__meminit",
116 103
117 # include/linux/init.h: 104 # include/linux/init.h:
118 "__init", 105 "__init",
119 "__ref", 106 "__ref",
120 107
121 # include/linux/linkage.h: 108 # include/linux/linkage.h:
122 "asmlinkage", 109 "asmlinkage",
123 <<
124 # include/linux/btf.h <<
125 "__bpf_kfunc", <<
126 ] 110 ]
127 111
128 else: 112 else:
129 extensions.append('cdomain') 113 extensions.append('cdomain')
130 114
131 # Ensure that autosectionlabel will produce un 115 # Ensure that autosectionlabel will produce unique names
132 autosectionlabel_prefix_document = True 116 autosectionlabel_prefix_document = True
133 autosectionlabel_maxdepth = 2 117 autosectionlabel_maxdepth = 2
134 118
135 # Load math renderer: !! 119 extensions.append("sphinx.ext.imgmath")
136 # For html builder, load imgmath only when its <<
137 # mathjax is the default math renderer since S <<
138 have_latex = have_command('latex') <<
139 have_dvipng = have_command('dvipng') <<
140 load_imgmath = have_latex and have_dvipng <<
141 <<
142 # Respect SPHINX_IMGMATH (for html docs only) <<
143 if 'SPHINX_IMGMATH' in os.environ: <<
144 env_sphinx_imgmath = os.environ['SPHINX_IM <<
145 if 'yes' in env_sphinx_imgmath: <<
146 load_imgmath = True <<
147 elif 'no' in env_sphinx_imgmath: <<
148 load_imgmath = False <<
149 else: <<
150 sys.stderr.write("Unknown env SPHINX_I <<
151 <<
152 # Always load imgmath for Sphinx <1.8 or for e <<
153 load_imgmath = (load_imgmath or (major == 1 an <<
154 or 'epub' in sys.argv) <<
155 <<
156 if load_imgmath: <<
157 extensions.append("sphinx.ext.imgmath") <<
158 math_renderer = 'imgmath' <<
159 else: <<
160 math_renderer = 'mathjax' <<
161 120
162 # Add any paths that contain templates here, r 121 # Add any paths that contain templates here, relative to this directory.
163 templates_path = ['sphinx/templates'] !! 122 templates_path = ['_templates']
164 123
165 # The suffix(es) of source filenames. 124 # The suffix(es) of source filenames.
166 # You can specify multiple suffix as a list of 125 # You can specify multiple suffix as a list of string:
167 # source_suffix = ['.rst', '.md'] 126 # source_suffix = ['.rst', '.md']
168 source_suffix = '.rst' 127 source_suffix = '.rst'
169 128
170 # The encoding of source files. 129 # The encoding of source files.
171 #source_encoding = 'utf-8-sig' 130 #source_encoding = 'utf-8-sig'
172 131
173 # The master toctree document. 132 # The master toctree document.
174 master_doc = 'index' 133 master_doc = 'index'
175 134
176 # General information about the project. 135 # General information about the project.
177 project = 'The Linux Kernel' 136 project = 'The Linux Kernel'
178 copyright = 'The kernel development community' 137 copyright = 'The kernel development community'
179 author = 'The kernel development community' 138 author = 'The kernel development community'
180 139
181 # The version info for the project you're docu 140 # The version info for the project you're documenting, acts as replacement for
182 # |version| and |release|, also used in variou 141 # |version| and |release|, also used in various other places throughout the
183 # built documents. 142 # built documents.
184 # 143 #
185 # In a normal build, version and release are a 144 # In a normal build, version and release are are set to KERNELVERSION and
186 # KERNELRELEASE, respectively, from the Makefi 145 # KERNELRELEASE, respectively, from the Makefile via Sphinx command line
187 # arguments. 146 # arguments.
188 # 147 #
189 # The following code tries to extract the info 148 # The following code tries to extract the information by reading the Makefile,
190 # when Sphinx is run directly (e.g. by Read th 149 # when Sphinx is run directly (e.g. by Read the Docs).
191 try: 150 try:
192 makefile_version = None 151 makefile_version = None
193 makefile_patchlevel = None 152 makefile_patchlevel = None
194 for line in open('../Makefile'): 153 for line in open('../Makefile'):
195 key, val = [x.strip() for x in line.sp 154 key, val = [x.strip() for x in line.split('=', 2)]
196 if key == 'VERSION': 155 if key == 'VERSION':
197 makefile_version = val 156 makefile_version = val
198 elif key == 'PATCHLEVEL': 157 elif key == 'PATCHLEVEL':
199 makefile_patchlevel = val 158 makefile_patchlevel = val
200 if makefile_version and makefile_patch 159 if makefile_version and makefile_patchlevel:
201 break 160 break
202 except: 161 except:
203 pass 162 pass
204 finally: 163 finally:
205 if makefile_version and makefile_patchleve 164 if makefile_version and makefile_patchlevel:
206 version = release = makefile_version + 165 version = release = makefile_version + '.' + makefile_patchlevel
207 else: 166 else:
208 version = release = "unknown version" 167 version = release = "unknown version"
209 168
210 # <<
211 # HACK: there seems to be no easy way for us t <<
212 # release information passed in from the makef <<
213 # command-line options and find it for ourselv <<
214 # <<
215 def get_cline_version(): <<
216 c_version = c_release = '' <<
217 for arg in sys.argv: <<
218 if arg.startswith('version='): <<
219 c_version = arg[8:] <<
220 elif arg.startswith('release='): <<
221 c_release = arg[8:] <<
222 if c_version: <<
223 if c_release: <<
224 return c_version + '-' + c_release <<
225 return c_version <<
226 return version # Whatever we came up with <<
227 <<
228 # The language for content autogenerated by Sp 169 # The language for content autogenerated by Sphinx. Refer to documentation
229 # for a list of supported languages. 170 # for a list of supported languages.
230 # 171 #
231 # This is also used if you do content translat 172 # This is also used if you do content translation via gettext catalogs.
232 # Usually you set "language" from the command 173 # Usually you set "language" from the command line for these cases.
233 language = 'en' !! 174 language = None
234 175
235 # There are two options for replacing |today|: 176 # There are two options for replacing |today|: either, you set today to some
236 # non-false value, then it is used: 177 # non-false value, then it is used:
237 #today = '' 178 #today = ''
238 # Else, today_fmt is used as the format for a 179 # Else, today_fmt is used as the format for a strftime call.
239 #today_fmt = '%B %d, %Y' 180 #today_fmt = '%B %d, %Y'
240 181
241 # List of patterns, relative to source directo 182 # List of patterns, relative to source directory, that match files and
242 # directories to ignore when looking for sourc 183 # directories to ignore when looking for source files.
243 exclude_patterns = ['output'] 184 exclude_patterns = ['output']
244 185
245 # The reST default role (used for this markup: 186 # The reST default role (used for this markup: `text`) to use for all
246 # documents. 187 # documents.
247 #default_role = None 188 #default_role = None
248 189
249 # If true, '()' will be appended to :func: etc 190 # If true, '()' will be appended to :func: etc. cross-reference text.
250 #add_function_parentheses = True 191 #add_function_parentheses = True
251 192
252 # If true, the current module name will be pre 193 # If true, the current module name will be prepended to all description
253 # unit titles (such as .. function::). 194 # unit titles (such as .. function::).
254 #add_module_names = True 195 #add_module_names = True
255 196
256 # If true, sectionauthor and moduleauthor dire 197 # If true, sectionauthor and moduleauthor directives will be shown in the
257 # output. They are ignored by default. 198 # output. They are ignored by default.
258 #show_authors = False 199 #show_authors = False
259 200
260 # The name of the Pygments (syntax highlightin 201 # The name of the Pygments (syntax highlighting) style to use.
261 pygments_style = 'sphinx' 202 pygments_style = 'sphinx'
262 203
263 # A list of ignored prefixes for module index 204 # A list of ignored prefixes for module index sorting.
264 #modindex_common_prefix = [] 205 #modindex_common_prefix = []
265 206
266 # If true, keep warnings as "system message" p 207 # If true, keep warnings as "system message" paragraphs in the built documents.
267 #keep_warnings = False 208 #keep_warnings = False
268 209
269 # If true, `todo` and `todoList` produce outpu 210 # If true, `todo` and `todoList` produce output, else they produce nothing.
270 todo_include_todos = False 211 todo_include_todos = False
271 212
272 primary_domain = 'c' 213 primary_domain = 'c'
273 highlight_language = 'none' 214 highlight_language = 'none'
274 215
275 # -- Options for HTML output ----------------- 216 # -- Options for HTML output ----------------------------------------------
276 217
277 # The theme to use for HTML and HTML Help page 218 # The theme to use for HTML and HTML Help pages. See the documentation for
278 # a list of builtin themes. 219 # a list of builtin themes.
279 220
280 # Default theme !! 221 # The Read the Docs theme is available from
281 html_theme = 'alabaster' !! 222 # - https://github.com/snide/sphinx_rtd_theme
282 html_css_files = [] !! 223 # - https://pypi.python.org/pypi/sphinx_rtd_theme
283 !! 224 # - python-sphinx-rtd-theme package (on Debian)
284 if "DOCS_THEME" in os.environ: !! 225 try:
285 html_theme = os.environ["DOCS_THEME"] !! 226 import sphinx_rtd_theme
286 !! 227 html_theme = 'sphinx_rtd_theme'
287 if html_theme == 'sphinx_rtd_theme' or html_th !! 228 html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
288 # Read the Docs theme !! 229 except ImportError:
289 try: !! 230 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')
290 import sphinx_rtd_theme !! 231
291 html_theme_path = [sphinx_rtd_theme.ge !! 232 # Theme options are theme-specific and customize the look and feel of a theme
292 !! 233 # further. For a list of options available for each theme, see the
293 # Add any paths that contain custom st !! 234 # documentation.
294 # relative to this directory. They are !! 235 #html_theme_options = {}
295 # so a file named "default.css" will o !! 236
296 html_css_files = [ !! 237 # Add any paths that contain custom themes here, relative to this directory.
297 'theme_overrides.css', !! 238 #html_theme_path = []
298 ] !! 239
>> 240 # The name for this set of Sphinx documents. If None, it defaults to
>> 241 # "<project> v<release> documentation".
>> 242 #html_title = None
299 243
300 # Read the Docs dark mode override the !! 244 # A shorter title for the navigation bar. Default is the same as html_title.
301 if html_theme == 'sphinx_rtd_dark_mode !! 245 #html_short_title = None
302 try: <<
303 import sphinx_rtd_dark_mode <<
304 extensions.append('sphinx_rtd_ <<
305 except ImportError: <<
306 html_theme == 'sphinx_rtd_them <<
307 <<
308 if html_theme == 'sphinx_rtd_theme': <<
309 # Add color-specific RTD norma <<
310 html_css_files.append('theme_r <<
311 <<
312 html_theme_options = { <<
313 'navigation_depth': -1, <<
314 } <<
315 <<
316 except ImportError: <<
317 html_theme = 'alabaster' <<
318 <<
319 if "DOCS_CSS" in os.environ: <<
320 css = os.environ["DOCS_CSS"].split(" ") <<
321 <<
322 for l in css: <<
323 html_css_files.append(l) <<
324 <<
325 if major <= 1 and minor < 8: <<
326 html_context = { <<
327 'css_files': [], <<
328 } <<
329 <<
330 for l in html_css_files: <<
331 html_context['css_files'].append('_sta <<
332 <<
333 if html_theme == 'alabaster': <<
334 html_theme_options = { <<
335 'description': get_cline_version(), <<
336 'page_width': '65em', <<
337 'sidebar_width': '15em', <<
338 'fixed_sidebar': 'true', <<
339 'font_size': 'inherit', <<
340 'font_family': 'serif', <<
341 } <<
342 246
343 sys.stderr.write("Using %s theme\n" % html_the !! 247 # The name of an image file (relative to this directory) to place at the top
>> 248 # of the sidebar.
>> 249 #html_logo = None
>> 250
>> 251 # The name of an image file (within the static path) to use as favicon of the
>> 252 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
>> 253 # pixels large.
>> 254 #html_favicon = None
344 255
345 # Add any paths that contain custom static fil 256 # Add any paths that contain custom static files (such as style sheets) here,
346 # relative to this directory. They are copied 257 # relative to this directory. They are copied after the builtin static files,
347 # so a file named "default.css" will overwrite 258 # so a file named "default.css" will overwrite the builtin "default.css".
>> 259
348 html_static_path = ['sphinx-static'] 260 html_static_path = ['sphinx-static']
349 261
350 # If true, Docutils "smart quotes" will be use !! 262 html_context = {
351 # to typographically correct entities. Howeve !! 263 'css_files': [
352 # is not always what we want, so enable only q !! 264 '_static/theme_overrides.css',
353 smartquotes_action = 'q' !! 265 ],
>> 266 }
>> 267
>> 268 # Add any extra paths that contain custom files (such as robots.txt or
>> 269 # .htaccess) here, relative to this directory. These files are copied
>> 270 # directly to the root of the documentation.
>> 271 #html_extra_path = []
>> 272
>> 273 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
>> 274 # using the given strftime format.
>> 275 #html_last_updated_fmt = '%b %d, %Y'
>> 276
>> 277 # If true, SmartyPants will be used to convert quotes and dashes to
>> 278 # typographically correct entities.
>> 279 html_use_smartypants = False
354 280
355 # Custom sidebar templates, maps document name 281 # Custom sidebar templates, maps document names to template names.
356 # Note that the RTD theme ignores this !! 282 #html_sidebars = {}
357 html_sidebars = { '**': ['searchbox.html', 'ke <<
358 283
359 # about.html is available for alabaster theme. !! 284 # Additional templates that should be rendered to pages, maps page names to
360 if html_theme == 'alabaster': !! 285 # template names.
361 html_sidebars['**'].insert(0, 'about.html' !! 286 #html_additional_pages = {}
362 287
363 # The name of an image file (relative to this !! 288 # If false, no module index is generated.
364 # of the sidebar. !! 289 #html_domain_indices = True
365 html_logo = 'images/logo.svg' !! 290
>> 291 # If false, no index is generated.
>> 292 #html_use_index = True
>> 293
>> 294 # If true, the index is split into individual pages for each letter.
>> 295 #html_split_index = False
>> 296
>> 297 # If true, links to the reST sources are added to the pages.
>> 298 #html_show_sourcelink = True
>> 299
>> 300 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
>> 301 #html_show_sphinx = True
>> 302
>> 303 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
>> 304 #html_show_copyright = True
>> 305
>> 306 # If true, an OpenSearch description file will be output, and all pages will
>> 307 # contain a <link> tag referring to it. The value of this option must be the
>> 308 # base URL from which the finished HTML is served.
>> 309 #html_use_opensearch = ''
>> 310
>> 311 # This is the file name suffix for HTML files (e.g. ".xhtml").
>> 312 #html_file_suffix = None
>> 313
>> 314 # Language to be used for generating the HTML full-text search index.
>> 315 # Sphinx supports the following languages:
>> 316 # 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja'
>> 317 # 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr'
>> 318 #html_search_language = 'en'
>> 319
>> 320 # A dictionary with options for the search language support, empty by default.
>> 321 # Now only 'ja' uses this config value
>> 322 #html_search_options = {'type': 'default'}
>> 323
>> 324 # The name of a javascript file (relative to the configuration directory) that
>> 325 # implements a search results scorer. If empty, the default will be used.
>> 326 #html_search_scorer = 'scorer.js'
366 327
367 # Output file base name for HTML help builder. 328 # Output file base name for HTML help builder.
368 htmlhelp_basename = 'TheLinuxKerneldoc' 329 htmlhelp_basename = 'TheLinuxKerneldoc'
369 330
370 # -- Options for LaTeX output ---------------- 331 # -- Options for LaTeX output ---------------------------------------------
371 332
372 latex_elements = { 333 latex_elements = {
373 # The paper size ('letterpaper' or 'a4pape !! 334 # The paper size ('letterpaper' or 'a4paper').
374 'papersize': 'a4paper', !! 335 'papersize': 'a4paper',
375 <<
376 # The font size ('10pt', '11pt' or '12pt') <<
377 'pointsize': '11pt', <<
378 336
379 # Latex figure (float) alignment !! 337 # The font size ('10pt', '11pt' or '12pt').
380 #'figure_align': 'htbp', !! 338 'pointsize': '11pt',
381 339
382 # Don't mangle with UTF-8 chars !! 340 # Latex figure (float) alignment
383 'inputenc': '', !! 341 #'figure_align': 'htbp',
384 'utf8extra': '', <<
385 <<
386 # Set document margins <<
387 'sphinxsetup': ''' <<
388 hmargin=0.5in, vmargin=1in, <<
389 parsedliteralwraps=true, <<
390 verbatimhintsturnover=false, <<
391 ''', <<
392 <<
393 # <<
394 # Some of our authors are fond of deep nes <<
395 # cope. <<
396 # <<
397 'maxlistdepth': '10', <<
398 342
399 # For CJK One-half spacing, need to be in !! 343 # Don't mangle with UTF-8 chars
400 'extrapackages': r'\usepackage{setspace}', !! 344 'inputenc': '',
>> 345 'utf8extra': '',
401 346
402 # Additional stuff for the LaTeX preamble. !! 347 # Additional stuff for the LaTeX preamble.
403 'preamble': ''' 348 'preamble': '''
404 % Use some font with UTF-8 support wit !! 349 % Use some font with UTF-8 support with XeLaTeX
405 \\usepackage{fontspec} 350 \\usepackage{fontspec}
406 \\setsansfont{DejaVu Sans} 351 \\setsansfont{DejaVu Sans}
407 \\setromanfont{DejaVu Serif} 352 \\setromanfont{DejaVu Serif}
408 \\setmonofont{DejaVu Sans Mono} 353 \\setmonofont{DejaVu Sans Mono}
409 ''', !! 354 '''
410 } 355 }
411 356
>> 357 # At least one book (translations) may have Asian characters
>> 358 # with are only displayed if xeCJK is used
>> 359
>> 360 cjk_cmd = check_output(['fc-list', '--format="%{family[0]}\n"']).decode('utf-8', 'ignore')
>> 361 if cjk_cmd.find("Noto Sans CJK SC") >= 0:
>> 362 print ("enabling CJK for LaTeX builder")
>> 363 latex_elements['preamble'] += '''
>> 364 % This is needed for translations
>> 365 \\usepackage{xeCJK}
>> 366 \\setCJKmainfont{Noto Sans CJK SC}
>> 367 '''
>> 368
412 # Fix reference escape troubles with Sphinx 1. 369 # Fix reference escape troubles with Sphinx 1.4.x
413 if major == 1: 370 if major == 1:
414 latex_elements['preamble'] += '\\renewcom 371 latex_elements['preamble'] += '\\renewcommand*{\\DUrole}[2]{ #2 }\n'
415 372
416 <<
417 # Load kerneldoc specific LaTeX settings <<
418 latex_elements['preamble'] += ''' <<
419 % Load kerneldoc specific LaTeX settin <<
420 \\input{kerneldoc-preamble.sty} <<
421 ''' <<
422 <<
423 # With Sphinx 1.6, it is possible to change th 373 # With Sphinx 1.6, it is possible to change the Bg color directly
424 # by using: 374 # by using:
425 # \definecolor{sphinxnoteBgColor}{RGB}{2 375 # \definecolor{sphinxnoteBgColor}{RGB}{204,255,255}
426 # \definecolor{sphinxwarningBgColor}{RGB 376 # \definecolor{sphinxwarningBgColor}{RGB}{255,204,204}
427 # \definecolor{sphinxattentionBgColor}{R 377 # \definecolor{sphinxattentionBgColor}{RGB}{255,255,204}
428 # \definecolor{sphinximportantBgColor}{R 378 # \definecolor{sphinximportantBgColor}{RGB}{192,255,204}
429 # 379 #
430 # However, it require to use sphinx heavy box 380 # However, it require to use sphinx heavy box with:
431 # 381 #
432 # \renewenvironment{sphinxlightbox} {% 382 # \renewenvironment{sphinxlightbox} {%
433 # \\begin{sphinxheavybox} 383 # \\begin{sphinxheavybox}
434 # } 384 # }
435 # \\end{sphinxheavybox} 385 # \\end{sphinxheavybox}
436 # } 386 # }
437 # 387 #
438 # Unfortunately, the implementation is buggy: 388 # Unfortunately, the implementation is buggy: if a note is inside a
439 # table, it isn't displayed well. So, for now, 389 # table, it isn't displayed well. So, for now, let's use boring
440 # black and white notes. 390 # black and white notes.
441 391
442 # Grouping the document tree into LaTeX files. 392 # Grouping the document tree into LaTeX files. List of tuples
443 # (source start file, target name, title, 393 # (source start file, target name, title,
444 # author, documentclass [howto, manual, or ow 394 # author, documentclass [howto, manual, or own class]).
445 # Sorted in alphabetical order 395 # Sorted in alphabetical order
446 latex_documents = [ 396 latex_documents = [
447 ] 397 ]
448 398
449 # Add all other index files from Documentation 399 # Add all other index files from Documentation/ subdirectories
450 for fn in os.listdir('.'): 400 for fn in os.listdir('.'):
451 doc = os.path.join(fn, "index") 401 doc = os.path.join(fn, "index")
452 if os.path.exists(doc + ".rst"): 402 if os.path.exists(doc + ".rst"):
453 has = False 403 has = False
454 for l in latex_documents: 404 for l in latex_documents:
455 if l[0] == doc: 405 if l[0] == doc:
456 has = True 406 has = True
457 break 407 break
458 if not has: 408 if not has:
459 latex_documents.append((doc, fn + 409 latex_documents.append((doc, fn + '.tex',
460 'Linux %s 410 'Linux %s Documentation' % fn.capitalize(),
461 'The kerne 411 'The kernel development community',
462 'manual')) 412 'manual'))
463 413
464 # The name of an image file (relative to this 414 # The name of an image file (relative to this directory) to place at the top of
465 # the title page. 415 # the title page.
466 #latex_logo = None 416 #latex_logo = None
467 417
468 # For "manual" documents, if this is true, the 418 # For "manual" documents, if this is true, then toplevel headings are parts,
469 # not chapters. 419 # not chapters.
470 #latex_use_parts = False 420 #latex_use_parts = False
471 421
472 # If true, show page references after internal 422 # If true, show page references after internal links.
473 #latex_show_pagerefs = False 423 #latex_show_pagerefs = False
474 424
475 # If true, show URL addresses after external l 425 # If true, show URL addresses after external links.
476 #latex_show_urls = False 426 #latex_show_urls = False
477 427
478 # Documents to append as an appendix to all ma 428 # Documents to append as an appendix to all manuals.
479 #latex_appendices = [] 429 #latex_appendices = []
480 430
481 # If false, no module index is generated. 431 # If false, no module index is generated.
482 #latex_domain_indices = True 432 #latex_domain_indices = True
483 433
484 # Additional LaTeX stuff to be copied to build <<
485 latex_additional_files = [ <<
486 'sphinx/kerneldoc-preamble.sty', <<
487 ] <<
488 <<
489 434
490 # -- Options for manual page output ---------- 435 # -- Options for manual page output ---------------------------------------
491 436
492 # One entry per manual page. List of tuples 437 # One entry per manual page. List of tuples
493 # (source start file, name, description, autho 438 # (source start file, name, description, authors, manual section).
494 man_pages = [ 439 man_pages = [
495 (master_doc, 'thelinuxkernel', 'The Linux 440 (master_doc, 'thelinuxkernel', 'The Linux Kernel Documentation',
496 [author], 1) 441 [author], 1)
497 ] 442 ]
498 443
499 # If true, show URL addresses after external l 444 # If true, show URL addresses after external links.
500 #man_show_urls = False 445 #man_show_urls = False
501 446
502 447
503 # -- Options for Texinfo output -------------- 448 # -- Options for Texinfo output -------------------------------------------
504 449
505 # Grouping the document tree into Texinfo file 450 # Grouping the document tree into Texinfo files. List of tuples
506 # (source start file, target name, title, auth 451 # (source start file, target name, title, author,
507 # dir menu entry, description, category) 452 # dir menu entry, description, category)
508 texinfo_documents = [ 453 texinfo_documents = [
509 (master_doc, 'TheLinuxKernel', 'The Linux 454 (master_doc, 'TheLinuxKernel', 'The Linux Kernel Documentation',
510 author, 'TheLinuxKernel', 'One line descr 455 author, 'TheLinuxKernel', 'One line description of project.',
511 'Miscellaneous'), 456 'Miscellaneous'),
512 ] 457 ]
513 458
>> 459 # Documents to append as an appendix to all manuals.
>> 460 #texinfo_appendices = []
>> 461
>> 462 # If false, no module index is generated.
>> 463 #texinfo_domain_indices = True
>> 464
>> 465 # How to display URL addresses: 'footnote', 'no', or 'inline'.
>> 466 #texinfo_show_urls = 'footnote'
>> 467
>> 468 # If true, do not generate a @detailmenu in the "Top" node's menu.
>> 469 #texinfo_no_detailmenu = False
>> 470
>> 471
514 # -- Options for Epub output ----------------- 472 # -- Options for Epub output ----------------------------------------------
515 473
516 # Bibliographic Dublin Core info. 474 # Bibliographic Dublin Core info.
517 epub_title = project 475 epub_title = project
518 epub_author = author 476 epub_author = author
519 epub_publisher = author 477 epub_publisher = author
520 epub_copyright = copyright 478 epub_copyright = copyright
521 479
>> 480 # The basename for the epub file. It defaults to the project name.
>> 481 #epub_basename = project
>> 482
>> 483 # The HTML theme for the epub output. Since the default themes are not
>> 484 # optimized for small screen space, using the same theme for HTML and epub
>> 485 # output is usually not wise. This defaults to 'epub', a theme designed to save
>> 486 # visual space.
>> 487 #epub_theme = 'epub'
>> 488
>> 489 # The language of the text. It defaults to the language option
>> 490 # or 'en' if the language is not set.
>> 491 #epub_language = ''
>> 492
>> 493 # The scheme of the identifier. Typical schemes are ISBN or URL.
>> 494 #epub_scheme = ''
>> 495
>> 496 # The unique identifier of the text. This can be a ISBN number
>> 497 # or the project homepage.
>> 498 #epub_identifier = ''
>> 499
>> 500 # A unique identification for the text.
>> 501 #epub_uid = ''
>> 502
>> 503 # A tuple containing the cover image and cover page html template filenames.
>> 504 #epub_cover = ()
>> 505
>> 506 # A sequence of (type, uri, title) tuples for the guide element of content.opf.
>> 507 #epub_guide = ()
>> 508
>> 509 # HTML files that should be inserted before the pages created by sphinx.
>> 510 # The format is a list of tuples containing the path and title.
>> 511 #epub_pre_files = []
>> 512
>> 513 # HTML files that should be inserted after the pages created by sphinx.
>> 514 # The format is a list of tuples containing the path and title.
>> 515 #epub_post_files = []
>> 516
522 # A list of files that should not be packed in 517 # A list of files that should not be packed into the epub file.
523 epub_exclude_files = ['search.html'] 518 epub_exclude_files = ['search.html']
>> 519
>> 520 # The depth of the table of contents in toc.ncx.
>> 521 #epub_tocdepth = 3
>> 522
>> 523 # Allow duplicate toc entries.
>> 524 #epub_tocdup = True
>> 525
>> 526 # Choose between 'default' and 'includehidden'.
>> 527 #epub_tocscope = 'default'
>> 528
>> 529 # Fix unsupported image types using the Pillow.
>> 530 #epub_fix_images = False
>> 531
>> 532 # Scale large images.
>> 533 #epub_max_image_width = 0
>> 534
>> 535 # How to display URL addresses: 'footnote', 'no', or 'inline'.
>> 536 #epub_show_urls = 'inline'
>> 537
>> 538 # If false, no index is generated.
>> 539 #epub_use_index = True
524 540
525 #======= 541 #=======
526 # rst2pdf 542 # rst2pdf
527 # 543 #
528 # Grouping the document tree into PDF files. L 544 # Grouping the document tree into PDF files. List of tuples
529 # (source start file, target name, title, auth 545 # (source start file, target name, title, author, options).
530 # 546 #
531 # See the Sphinx chapter of https://ralsina.me 547 # See the Sphinx chapter of https://ralsina.me/static/manual.pdf
532 # 548 #
533 # FIXME: Do not add the index file here; the r 549 # FIXME: Do not add the index file here; the result will be too big. Adding
534 # multiple PDF files here actually tries to ge 550 # multiple PDF files here actually tries to get the cross-referencing right
535 # *between* PDF files. 551 # *between* PDF files.
536 pdf_documents = [ 552 pdf_documents = [
537 ('kernel-documentation', u'Kernel', u'Kern 553 ('kernel-documentation', u'Kernel', u'Kernel', u'J. Random Bozo'),
538 ] 554 ]
539 555
540 # kernel-doc extension configuration for runni 556 # kernel-doc extension configuration for running Sphinx directly (e.g. by Read
541 # the Docs). In a normal build, these are supp 557 # the Docs). In a normal build, these are supplied from the Makefile via command
542 # line arguments. 558 # line arguments.
543 kerneldoc_bin = '../scripts/kernel-doc' 559 kerneldoc_bin = '../scripts/kernel-doc'
544 kerneldoc_srctree = '..' 560 kerneldoc_srctree = '..'
545 561
546 # -------------------------------------------- 562 # ------------------------------------------------------------------------------
547 # Since loadConfig overwrites settings from th 563 # Since loadConfig overwrites settings from the global namespace, it has to be
548 # the last statement in the conf.py file 564 # the last statement in the conf.py file
549 # -------------------------------------------- 565 # ------------------------------------------------------------------------------
550 loadConfig(globals()) 566 loadConfig(globals())
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.