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