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