Commit | Line | Data |
---|---|---|
22cba31b JN |
1 | # -*- coding: utf-8 -*- |
2 | # | |
3 | # The Linux Kernel documentation build configuration file, created by | |
4 | # sphinx-quickstart on Fri Feb 12 13:51:46 2016. | |
5 | # | |
6 | # This file is execfile()d with the current directory set to its | |
7 | # containing dir. | |
8 | # | |
9 | # Note that not all possible configuration values are present in this | |
10 | # autogenerated file. | |
11 | # | |
12 | # All configuration values have a default; values that are commented out | |
13 | # serve to show the default. | |
14 | ||
15 | import sys | |
16 | import os | |
d4fe7e14 | 17 | import sphinx |
6b0d3e7c AY |
18 | import shutil |
19 | ||
20 | # helper | |
21 | # ------ | |
22 | ||
23 | def have_command(cmd): | |
24 | """Search ``cmd`` in the ``PATH`` environment. | |
25 | ||
26 | If found, return True. | |
27 | If not found, return False. | |
28 | """ | |
29 | return shutil.which(cmd) is not None | |
d4fe7e14 MCC |
30 | |
31 | # Get Sphinx version | |
c46988ae | 32 | major, minor, patch = sphinx.version_info[:3] |
d4fe7e14 | 33 | |
31abfdda JC |
34 | # |
35 | # Warn about older versions that we don't want to support for much | |
36 | # longer. | |
37 | # | |
38 | if (major < 2) or (major == 2 and minor < 4): | |
39 | print('WARNING: support for Sphinx < 2.4 will be removed soon.') | |
22cba31b JN |
40 | |
41 | # If extensions (or modules to document with autodoc) are in another directory, | |
42 | # add these directories to sys.path here. If the directory is relative to the | |
43 | # documentation root, use os.path.abspath to make it absolute, like shown here. | |
24dcdeb2 | 44 | sys.path.insert(0, os.path.abspath('sphinx')) |
606b9ac8 | 45 | from load_config import loadConfig |
22cba31b JN |
46 | |
47 | # -- General configuration ------------------------------------------------ | |
48 | ||
49 | # If your documentation needs a minimal Sphinx version, state it here. | |
f546ff0c | 50 | needs_sphinx = '1.7' |
22cba31b JN |
51 | |
52 | # Add any Sphinx extension module names here, as strings. They can be | |
53 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom | |
54 | # ones. | |
afde706a | 55 | extensions = ['kerneldoc', 'rstFlatTable', 'kernel_include', |
aa204855 | 56 | 'kfigure', 'sphinx.ext.ifconfig', 'automarkup', |
a7ee04b3 | 57 | 'maintainers_include', 'sphinx.ext.autosectionlabel', |
63fdc462 | 58 | 'kernel_abi', 'kernel_feat'] |
22cba31b | 59 | |
afde706a | 60 | if major >= 3: |
d29f34c0 | 61 | if (major > 3) or (minor > 0 or patch >= 2): |
b34b86d7 MCC |
62 | # Sphinx c function parser is more pedantic with regards to type |
63 | # checking. Due to that, having macros at c:function cause problems. | |
64 | # Those needed to be scaped by using c_id_attributes[] array | |
65 | c_id_attributes = [ | |
66 | # GCC Compiler types not parsed by Sphinx: | |
67 | "__restrict__", | |
68 | ||
69 | # include/linux/compiler_types.h: | |
70 | "__iomem", | |
71 | "__kernel", | |
72 | "noinstr", | |
73 | "notrace", | |
74 | "__percpu", | |
75 | "__rcu", | |
76 | "__user", | |
77 | ||
78 | # include/linux/compiler_attributes.h: | |
79 | "__alias", | |
80 | "__aligned", | |
81 | "__aligned_largest", | |
82 | "__always_inline", | |
83 | "__assume_aligned", | |
84 | "__cold", | |
85 | "__attribute_const__", | |
86 | "__copy", | |
87 | "__pure", | |
88 | "__designated_init", | |
89 | "__visible", | |
90 | "__printf", | |
91 | "__scanf", | |
92 | "__gnu_inline", | |
93 | "__malloc", | |
94 | "__mode", | |
95 | "__no_caller_saved_registers", | |
96 | "__noclone", | |
97 | "__nonstring", | |
98 | "__noreturn", | |
99 | "__packed", | |
100 | "__pure", | |
101 | "__section", | |
102 | "__always_unused", | |
103 | "__maybe_unused", | |
104 | "__used", | |
105 | "__weak", | |
106 | "noinline", | |
5479d6d4 | 107 | "__fix_address", |
b34b86d7 MCC |
108 | |
109 | # include/linux/memblock.h: | |
110 | "__init_memblock", | |
111 | "__meminit", | |
112 | ||
113 | # include/linux/init.h: | |
114 | "__init", | |
115 | "__ref", | |
116 | ||
117 | # include/linux/linkage.h: | |
118 | "asmlinkage", | |
119 | ] | |
120 | ||
afde706a JC |
121 | else: |
122 | extensions.append('cdomain') | |
123 | ||
4658b0eb MCC |
124 | # Ensure that autosectionlabel will produce unique names |
125 | autosectionlabel_prefix_document = True | |
126 | autosectionlabel_maxdepth = 2 | |
127 | ||
6b0d3e7c AY |
128 | # Load math renderer: |
129 | # For html builder, load imgmath only when its dependencies are met. | |
130 | # mathjax is the default math renderer since Sphinx 1.8. | |
131 | have_latex = have_command('latex') | |
132 | have_dvipng = have_command('dvipng') | |
3b384e95 AY |
133 | load_imgmath = have_latex and have_dvipng |
134 | ||
135 | # Respect SPHINX_IMGMATH (for html docs only) | |
136 | if 'SPHINX_IMGMATH' in os.environ: | |
137 | env_sphinx_imgmath = os.environ['SPHINX_IMGMATH'] | |
138 | if 'yes' in env_sphinx_imgmath: | |
139 | load_imgmath = True | |
140 | elif 'no' in env_sphinx_imgmath: | |
141 | load_imgmath = False | |
142 | else: | |
143 | sys.stderr.write("Unknown env SPHINX_IMGMATH=%s ignored.\n" % env_sphinx_imgmath) | |
144 | ||
145 | # Always load imgmath for Sphinx <1.8 or for epub docs | |
146 | load_imgmath = (load_imgmath or (major == 1 and minor < 8) | |
6b0d3e7c AY |
147 | or 'epub' in sys.argv) |
148 | ||
149 | if load_imgmath: | |
150 | extensions.append("sphinx.ext.imgmath") | |
151 | math_renderer = 'imgmath' | |
152 | else: | |
153 | math_renderer = 'mathjax' | |
22cba31b JN |
154 | |
155 | # Add any paths that contain templates here, relative to this directory. | |
156 | templates_path = ['_templates'] | |
157 | ||
158 | # The suffix(es) of source filenames. | |
159 | # You can specify multiple suffix as a list of string: | |
160 | # source_suffix = ['.rst', '.md'] | |
161 | source_suffix = '.rst' | |
162 | ||
163 | # The encoding of source files. | |
164 | #source_encoding = 'utf-8-sig' | |
165 | ||
166 | # The master toctree document. | |
167 | master_doc = 'index' | |
168 | ||
169 | # General information about the project. | |
170 | project = 'The Linux Kernel' | |
dc36143f | 171 | copyright = 'The kernel development community' |
22cba31b JN |
172 | author = 'The kernel development community' |
173 | ||
174 | # The version info for the project you're documenting, acts as replacement for | |
175 | # |version| and |release|, also used in various other places throughout the | |
176 | # built documents. | |
177 | # | |
c13ce448 JN |
178 | # In a normal build, version and release are are set to KERNELVERSION and |
179 | # KERNELRELEASE, respectively, from the Makefile via Sphinx command line | |
180 | # arguments. | |
181 | # | |
182 | # The following code tries to extract the information by reading the Makefile, | |
183 | # when Sphinx is run directly (e.g. by Read the Docs). | |
184 | try: | |
185 | makefile_version = None | |
186 | makefile_patchlevel = None | |
187 | for line in open('../Makefile'): | |
188 | key, val = [x.strip() for x in line.split('=', 2)] | |
189 | if key == 'VERSION': | |
190 | makefile_version = val | |
191 | elif key == 'PATCHLEVEL': | |
192 | makefile_patchlevel = val | |
193 | if makefile_version and makefile_patchlevel: | |
194 | break | |
195 | except: | |
196 | pass | |
197 | finally: | |
198 | if makefile_version and makefile_patchlevel: | |
199 | version = release = makefile_version + '.' + makefile_patchlevel | |
200 | else: | |
c13ce448 | 201 | version = release = "unknown version" |
22cba31b | 202 | |
d5389d31 JC |
203 | # |
204 | # HACK: there seems to be no easy way for us to get at the version and | |
205 | # release information passed in from the makefile...so go pawing through the | |
206 | # command-line options and find it for ourselves. | |
207 | # | |
208 | def get_cline_version(): | |
209 | c_version = c_release = '' | |
210 | for arg in sys.argv: | |
211 | if arg.startswith('version='): | |
212 | c_version = arg[8:] | |
213 | elif arg.startswith('release='): | |
214 | c_release = arg[8:] | |
215 | if c_version: | |
216 | if c_release: | |
217 | return c_version + '-' + c_release | |
218 | return c_version | |
219 | return version # Whatever we came up with before | |
220 | ||
22cba31b JN |
221 | # The language for content autogenerated by Sphinx. Refer to documentation |
222 | # for a list of supported languages. | |
223 | # | |
224 | # This is also used if you do content translation via gettext catalogs. | |
225 | # Usually you set "language" from the command line for these cases. | |
627f01ea | 226 | language = 'en' |
22cba31b JN |
227 | |
228 | # There are two options for replacing |today|: either, you set today to some | |
229 | # non-false value, then it is used: | |
230 | #today = '' | |
231 | # Else, today_fmt is used as the format for a strftime call. | |
232 | #today_fmt = '%B %d, %Y' | |
233 | ||
234 | # List of patterns, relative to source directory, that match files and | |
235 | # directories to ignore when looking for source files. | |
236 | exclude_patterns = ['output'] | |
237 | ||
238 | # The reST default role (used for this markup: `text`) to use for all | |
239 | # documents. | |
240 | #default_role = None | |
241 | ||
242 | # If true, '()' will be appended to :func: etc. cross-reference text. | |
243 | #add_function_parentheses = True | |
244 | ||
245 | # If true, the current module name will be prepended to all description | |
246 | # unit titles (such as .. function::). | |
247 | #add_module_names = True | |
248 | ||
249 | # If true, sectionauthor and moduleauthor directives will be shown in the | |
250 | # output. They are ignored by default. | |
251 | #show_authors = False | |
252 | ||
253 | # The name of the Pygments (syntax highlighting) style to use. | |
254 | pygments_style = 'sphinx' | |
255 | ||
256 | # A list of ignored prefixes for module index sorting. | |
257 | #modindex_common_prefix = [] | |
258 | ||
259 | # If true, keep warnings as "system message" paragraphs in the built documents. | |
260 | #keep_warnings = False | |
261 | ||
262 | # If true, `todo` and `todoList` produce output, else they produce nothing. | |
263 | todo_include_todos = False | |
264 | ||
fd5d6669 | 265 | primary_domain = 'c' |
b459106e | 266 | highlight_language = 'none' |
22cba31b JN |
267 | |
268 | # -- Options for HTML output ---------------------------------------------- | |
269 | ||
270 | # The theme to use for HTML and HTML Help pages. See the documentation for | |
271 | # a list of builtin themes. | |
272 | ||
fca7216b | 273 | # Default theme |
d5389d31 | 274 | html_theme = 'alabaster' |
135707d3 | 275 | html_css_files = [] |
fca7216b MCC |
276 | |
277 | if "DOCS_THEME" in os.environ: | |
278 | html_theme = os.environ["DOCS_THEME"] | |
279 | ||
a6fb8b5a | 280 | if html_theme == 'sphinx_rtd_theme' or html_theme == 'sphinx_rtd_dark_mode': |
fca7216b MCC |
281 | # Read the Docs theme |
282 | try: | |
283 | import sphinx_rtd_theme | |
284 | html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] | |
285 | ||
286 | # Add any paths that contain custom static files (such as style sheets) here, | |
287 | # relative to this directory. They are copied after the builtin static files, | |
288 | # so a file named "default.css" will overwrite the builtin "default.css". | |
289 | html_css_files = [ | |
290 | 'theme_overrides.css', | |
291 | ] | |
a6fb8b5a MCC |
292 | |
293 | # Read the Docs dark mode override theme | |
294 | if html_theme == 'sphinx_rtd_dark_mode': | |
295 | try: | |
296 | import sphinx_rtd_dark_mode | |
297 | extensions.append('sphinx_rtd_dark_mode') | |
298 | except ImportError: | |
299 | html_theme == 'sphinx_rtd_theme' | |
300 | ||
301 | if html_theme == 'sphinx_rtd_theme': | |
302 | # Add color-specific RTD normal mode | |
303 | html_css_files.append('theme_rtd_colors.css') | |
304 | ||
e17f2260 DV |
305 | html_theme_options = { |
306 | 'navigation_depth': -1, | |
307 | } | |
308 | ||
fca7216b | 309 | except ImportError: |
02d33e86 | 310 | html_theme = 'alabaster' |
fca7216b | 311 | |
135707d3 MCC |
312 | if "DOCS_CSS" in os.environ: |
313 | css = os.environ["DOCS_CSS"].split(" ") | |
314 | ||
315 | for l in css: | |
316 | html_css_files.append(l) | |
317 | ||
fca7216b MCC |
318 | if major <= 1 and minor < 8: |
319 | html_context = { | |
320 | 'css_files': [], | |
321 | } | |
322 | ||
323 | for l in html_css_files: | |
324 | html_context['css_files'].append('_static/' + l) | |
325 | ||
02d33e86 | 326 | if html_theme == 'alabaster': |
d5389d31 JC |
327 | html_theme_options = { |
328 | 'description': get_cline_version(), | |
2056b920 JC |
329 | 'page_width': '65em', |
330 | 'sidebar_width': '15em', | |
bd5d1cc8 JC |
331 | 'font_size': 'inherit', |
332 | 'font_family': 'serif', | |
d5389d31 | 333 | } |
ffc901b4 | 334 | |
fca7216b | 335 | sys.stderr.write("Using %s theme\n" % html_theme) |
22cba31b | 336 | |
22cba31b JN |
337 | # Add any paths that contain custom static files (such as style sheets) here, |
338 | # relative to this directory. They are copied after the builtin static files, | |
339 | # so a file named "default.css" will overwrite the builtin "default.css". | |
bc214671 MH |
340 | html_static_path = ['sphinx-static'] |
341 | ||
22cba31b JN |
342 | # If true, SmartyPants will be used to convert quotes and dashes to |
343 | # typographically correct entities. | |
7282a93f | 344 | html_use_smartypants = False |
22cba31b JN |
345 | |
346 | # Custom sidebar templates, maps document names to template names. | |
d5389d31 | 347 | # Note that the RTD theme ignores this |
a33ae832 AY |
348 | html_sidebars = { '**': ['searchbox.html', 'localtoc.html', 'sourcelink.html']} |
349 | ||
350 | # about.html is available for alabaster theme. Add it at the front. | |
351 | if html_theme == 'alabaster': | |
352 | html_sidebars['**'].insert(0, 'about.html') | |
22cba31b | 353 | |
22cba31b JN |
354 | # Output file base name for HTML help builder. |
355 | htmlhelp_basename = 'TheLinuxKerneldoc' | |
356 | ||
357 | # -- Options for LaTeX output --------------------------------------------- | |
358 | ||
359 | latex_elements = { | |
3b4c9632 MCC |
360 | # The paper size ('letterpaper' or 'a4paper'). |
361 | 'papersize': 'a4paper', | |
22cba31b | 362 | |
3b4c9632 MCC |
363 | # The font size ('10pt', '11pt' or '12pt'). |
364 | 'pointsize': '11pt', | |
22cba31b | 365 | |
3b4c9632 MCC |
366 | # Latex figure (float) alignment |
367 | #'figure_align': 'htbp', | |
caee5cde | 368 | |
3b4c9632 MCC |
369 | # Don't mangle with UTF-8 chars |
370 | 'inputenc': '', | |
371 | 'utf8extra': '', | |
a682ec4b | 372 | |
3b4c9632 MCC |
373 | # Set document margins |
374 | 'sphinxsetup': ''' | |
375 | hmargin=0.5in, vmargin=1in, | |
376 | parsedliteralwraps=true, | |
377 | verbatimhintsturnover=false, | |
378 | ''', | |
379 | ||
77abc2c2 AY |
380 | # For CJK One-half spacing, need to be in front of hyperref |
381 | 'extrapackages': r'\usepackage{setspace}', | |
382 | ||
3b4c9632 | 383 | # Additional stuff for the LaTeX preamble. |
caee5cde | 384 | 'preamble': ''' |
3b4c9632 | 385 | % Use some font with UTF-8 support with XeLaTeX |
9fdcd6af | 386 | \\usepackage{fontspec} |
44ba0bb4 DW |
387 | \\setsansfont{DejaVu Sans} |
388 | \\setromanfont{DejaVu Serif} | |
9fdcd6af | 389 | \\setmonofont{DejaVu Sans Mono} |
398f7abd | 390 | ''', |
e0de2b59 | 391 | } |
9fdcd6af | 392 | |
9fdcd6af | 393 | # Fix reference escape troubles with Sphinx 1.4.x |
f546ff0c | 394 | if major == 1: |
9fdcd6af MCC |
395 | latex_elements['preamble'] += '\\renewcommand*{\\DUrole}[2]{ #2 }\n' |
396 | ||
398f7abd AY |
397 | |
398 | # Load kerneldoc specific LaTeX settings | |
399 | latex_elements['preamble'] += ''' | |
400 | % Load kerneldoc specific LaTeX settings | |
401 | \\input{kerneldoc-preamble.sty} | |
402 | ''' | |
403 | ||
9fdcd6af MCC |
404 | # With Sphinx 1.6, it is possible to change the Bg color directly |
405 | # by using: | |
406 | # \definecolor{sphinxnoteBgColor}{RGB}{204,255,255} | |
407 | # \definecolor{sphinxwarningBgColor}{RGB}{255,204,204} | |
408 | # \definecolor{sphinxattentionBgColor}{RGB}{255,255,204} | |
409 | # \definecolor{sphinximportantBgColor}{RGB}{192,255,204} | |
410 | # | |
411 | # However, it require to use sphinx heavy box with: | |
412 | # | |
413 | # \renewenvironment{sphinxlightbox} {% | |
414 | # \\begin{sphinxheavybox} | |
415 | # } | |
416 | # \\end{sphinxheavybox} | |
417 | # } | |
418 | # | |
419 | # Unfortunately, the implementation is buggy: if a note is inside a | |
420 | # table, it isn't displayed well. So, for now, let's use boring | |
421 | # black and white notes. | |
633d612b | 422 | |
22cba31b JN |
423 | # Grouping the document tree into LaTeX files. List of tuples |
424 | # (source start file, target name, title, | |
425 | # author, documentclass [howto, manual, or own class]). | |
c2b563d8 | 426 | # Sorted in alphabetical order |
22cba31b | 427 | latex_documents = [ |
22cba31b JN |
428 | ] |
429 | ||
9d42afbe MCC |
430 | # Add all other index files from Documentation/ subdirectories |
431 | for fn in os.listdir('.'): | |
432 | doc = os.path.join(fn, "index") | |
433 | if os.path.exists(doc + ".rst"): | |
434 | has = False | |
435 | for l in latex_documents: | |
436 | if l[0] == doc: | |
437 | has = True | |
438 | break | |
439 | if not has: | |
440 | latex_documents.append((doc, fn + '.tex', | |
441 | 'Linux %s Documentation' % fn.capitalize(), | |
442 | 'The kernel development community', | |
443 | 'manual')) | |
444 | ||
22cba31b JN |
445 | # The name of an image file (relative to this directory) to place at the top of |
446 | # the title page. | |
447 | #latex_logo = None | |
448 | ||
449 | # For "manual" documents, if this is true, then toplevel headings are parts, | |
450 | # not chapters. | |
451 | #latex_use_parts = False | |
452 | ||
453 | # If true, show page references after internal links. | |
454 | #latex_show_pagerefs = False | |
455 | ||
456 | # If true, show URL addresses after external links. | |
457 | #latex_show_urls = False | |
458 | ||
459 | # Documents to append as an appendix to all manuals. | |
460 | #latex_appendices = [] | |
461 | ||
462 | # If false, no module index is generated. | |
463 | #latex_domain_indices = True | |
464 | ||
398f7abd AY |
465 | # Additional LaTeX stuff to be copied to build directory |
466 | latex_additional_files = [ | |
467 | 'sphinx/kerneldoc-preamble.sty', | |
468 | ] | |
469 | ||
22cba31b JN |
470 | |
471 | # -- Options for manual page output --------------------------------------- | |
472 | ||
473 | # One entry per manual page. List of tuples | |
474 | # (source start file, name, description, authors, manual section). | |
475 | man_pages = [ | |
476 | (master_doc, 'thelinuxkernel', 'The Linux Kernel Documentation', | |
477 | [author], 1) | |
478 | ] | |
479 | ||
480 | # If true, show URL addresses after external links. | |
481 | #man_show_urls = False | |
482 | ||
483 | ||
484 | # -- Options for Texinfo output ------------------------------------------- | |
485 | ||
486 | # Grouping the document tree into Texinfo files. List of tuples | |
487 | # (source start file, target name, title, author, | |
488 | # dir menu entry, description, category) | |
489 | texinfo_documents = [ | |
490 | (master_doc, 'TheLinuxKernel', 'The Linux Kernel Documentation', | |
491 | author, 'TheLinuxKernel', 'One line description of project.', | |
492 | 'Miscellaneous'), | |
493 | ] | |
494 | ||
22cba31b JN |
495 | # -- Options for Epub output ---------------------------------------------- |
496 | ||
497 | # Bibliographic Dublin Core info. | |
498 | epub_title = project | |
499 | epub_author = author | |
500 | epub_publisher = author | |
501 | epub_copyright = copyright | |
502 | ||
22cba31b JN |
503 | # A list of files that should not be packed into the epub file. |
504 | epub_exclude_files = ['search.html'] | |
505 | ||
22cba31b JN |
506 | #======= |
507 | # rst2pdf | |
508 | # | |
509 | # Grouping the document tree into PDF files. List of tuples | |
510 | # (source start file, target name, title, author, options). | |
511 | # | |
93431e06 | 512 | # See the Sphinx chapter of https://ralsina.me/static/manual.pdf |
22cba31b JN |
513 | # |
514 | # FIXME: Do not add the index file here; the result will be too big. Adding | |
515 | # multiple PDF files here actually tries to get the cross-referencing right | |
516 | # *between* PDF files. | |
517 | pdf_documents = [ | |
520a2477 | 518 | ('kernel-documentation', u'Kernel', u'Kernel', u'J. Random Bozo'), |
22cba31b | 519 | ] |
24dcdeb2 JN |
520 | |
521 | # kernel-doc extension configuration for running Sphinx directly (e.g. by Read | |
522 | # the Docs). In a normal build, these are supplied from the Makefile via command | |
523 | # line arguments. | |
524 | kerneldoc_bin = '../scripts/kernel-doc' | |
525 | kerneldoc_srctree = '..' | |
606b9ac8 MH |
526 | |
527 | # ------------------------------------------------------------------------------ | |
528 | # Since loadConfig overwrites settings from the global namespace, it has to be | |
529 | # the last statement in the conf.py file | |
530 | # ------------------------------------------------------------------------------ | |
531 | loadConfig(globals()) |