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