1 # -*- coding: utf-8 -*-
3 # The Linux Kernel documentation build configuration file, created by
4 # sphinx-quickstart on Fri Feb 12 13:51:46 2016.
6 # This file is execfile()d with the current directory set to its
9 # Note that not all possible configuration values are present in this
12 # All configuration values have a default; values that are commented out
13 # serve to show the default.
19 from subprocess import check_output
22 major, minor, patch = sphinx.version_info[:3]
25 # If extensions (or modules to document with autodoc) are in another directory,
26 # add these directories to sys.path here. If the directory is relative to the
27 # documentation root, use os.path.abspath to make it absolute, like shown here.
28 sys.path.insert(0, os.path.abspath('sphinx'))
29 from load_config import loadConfig
31 # -- General configuration ------------------------------------------------
33 # If your documentation needs a minimal Sphinx version, state it here.
36 # Add any Sphinx extension module names here, as strings. They can be
37 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
39 extensions = ['kerneldoc', 'rstFlatTable', 'kernel_include',
40 'kfigure', 'sphinx.ext.ifconfig', 'automarkup',
41 'maintainers_include', 'sphinx.ext.autosectionlabel',
42 'kernel_abi', 'kernel_feat']
45 if (major > 3) or (minor > 0 or patch >= 2):
46 # Sphinx c function parser is more pedantic with regards to type
47 # checking. Due to that, having macros at c:function cause problems.
48 # Those needed to be scaped by using c_id_attributes[] array
50 # GCC Compiler types not parsed by Sphinx:
53 # include/linux/compiler_types.h:
62 # include/linux/compiler_attributes.h:
69 "__attribute_const__",
79 "__no_caller_saved_registers",
92 # include/linux/memblock.h:
96 # include/linux/init.h:
100 # include/linux/linkage.h:
105 extensions.append('cdomain')
107 # Ensure that autosectionlabel will produce unique names
108 autosectionlabel_prefix_document = True
109 autosectionlabel_maxdepth = 2
111 extensions.append("sphinx.ext.imgmath")
113 # Add any paths that contain templates here, relative to this directory.
114 templates_path = ['_templates']
116 # The suffix(es) of source filenames.
117 # You can specify multiple suffix as a list of string:
118 # source_suffix = ['.rst', '.md']
119 source_suffix = '.rst'
121 # The encoding of source files.
122 #source_encoding = 'utf-8-sig'
124 # The master toctree document.
127 # General information about the project.
128 project = 'The Linux Kernel'
129 copyright = 'The kernel development community'
130 author = 'The kernel development community'
132 # The version info for the project you're documenting, acts as replacement for
133 # |version| and |release|, also used in various other places throughout the
136 # In a normal build, version and release are are set to KERNELVERSION and
137 # KERNELRELEASE, respectively, from the Makefile via Sphinx command line
140 # The following code tries to extract the information by reading the Makefile,
141 # when Sphinx is run directly (e.g. by Read the Docs).
143 makefile_version = None
144 makefile_patchlevel = None
145 for line in open('../Makefile'):
146 key, val = [x.strip() for x in line.split('=', 2)]
148 makefile_version = val
149 elif key == 'PATCHLEVEL':
150 makefile_patchlevel = val
151 if makefile_version and makefile_patchlevel:
156 if makefile_version and makefile_patchlevel:
157 version = release = makefile_version + '.' + makefile_patchlevel
159 version = release = "unknown version"
161 # The language for content autogenerated by Sphinx. Refer to documentation
162 # for a list of supported languages.
164 # This is also used if you do content translation via gettext catalogs.
165 # Usually you set "language" from the command line for these cases.
168 # There are two options for replacing |today|: either, you set today to some
169 # non-false value, then it is used:
171 # Else, today_fmt is used as the format for a strftime call.
172 #today_fmt = '%B %d, %Y'
174 # List of patterns, relative to source directory, that match files and
175 # directories to ignore when looking for source files.
176 exclude_patterns = ['output']
178 # The reST default role (used for this markup: `text`) to use for all
182 # If true, '()' will be appended to :func: etc. cross-reference text.
183 #add_function_parentheses = True
185 # If true, the current module name will be prepended to all description
186 # unit titles (such as .. function::).
187 #add_module_names = True
189 # If true, sectionauthor and moduleauthor directives will be shown in the
190 # output. They are ignored by default.
191 #show_authors = False
193 # The name of the Pygments (syntax highlighting) style to use.
194 pygments_style = 'sphinx'
196 # A list of ignored prefixes for module index sorting.
197 #modindex_common_prefix = []
199 # If true, keep warnings as "system message" paragraphs in the built documents.
200 #keep_warnings = False
202 # If true, `todo` and `todoList` produce output, else they produce nothing.
203 todo_include_todos = False
206 highlight_language = 'none'
208 # -- Options for HTML output ----------------------------------------------
210 # The theme to use for HTML and HTML Help pages. See the documentation for
211 # a list of builtin themes.
213 # The Read the Docs theme is available from
214 # - https://github.com/snide/sphinx_rtd_theme
215 # - https://pypi.python.org/pypi/sphinx_rtd_theme
216 # - python-sphinx-rtd-theme package (on Debian)
218 import sphinx_rtd_theme
219 html_theme = 'sphinx_rtd_theme'
220 html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
222 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')
224 # Theme options are theme-specific and customize the look and feel of a theme
225 # further. For a list of options available for each theme, see the
227 #html_theme_options = {}
229 # Add any paths that contain custom themes here, relative to this directory.
230 #html_theme_path = []
232 # The name for this set of Sphinx documents. If None, it defaults to
233 # "<project> v<release> documentation".
236 # A shorter title for the navigation bar. Default is the same as html_title.
237 #html_short_title = None
239 # The name of an image file (relative to this directory) to place at the top
243 # The name of an image file (within the static path) to use as favicon of the
244 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
248 # Add any paths that contain custom static files (such as style sheets) here,
249 # relative to this directory. They are copied after the builtin static files,
250 # so a file named "default.css" will overwrite the builtin "default.css".
252 html_static_path = ['sphinx-static']
256 '_static/theme_overrides.css',
260 # Add any extra paths that contain custom files (such as robots.txt or
261 # .htaccess) here, relative to this directory. These files are copied
262 # directly to the root of the documentation.
263 #html_extra_path = []
265 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
266 # using the given strftime format.
267 #html_last_updated_fmt = '%b %d, %Y'
269 # If true, SmartyPants will be used to convert quotes and dashes to
270 # typographically correct entities.
271 html_use_smartypants = False
273 # Custom sidebar templates, maps document names to template names.
276 # Additional templates that should be rendered to pages, maps page names to
278 #html_additional_pages = {}
280 # If false, no module index is generated.
281 #html_domain_indices = True
283 # If false, no index is generated.
284 #html_use_index = True
286 # If true, the index is split into individual pages for each letter.
287 #html_split_index = False
289 # If true, links to the reST sources are added to the pages.
290 #html_show_sourcelink = True
292 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
293 #html_show_sphinx = True
295 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
296 #html_show_copyright = True
298 # If true, an OpenSearch description file will be output, and all pages will
299 # contain a <link> tag referring to it. The value of this option must be the
300 # base URL from which the finished HTML is served.
301 #html_use_opensearch = ''
303 # This is the file name suffix for HTML files (e.g. ".xhtml").
304 #html_file_suffix = None
306 # Language to be used for generating the HTML full-text search index.
307 # Sphinx supports the following languages:
308 # 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja'
309 # 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr'
310 #html_search_language = 'en'
312 # A dictionary with options for the search language support, empty by default.
313 # Now only 'ja' uses this config value
314 #html_search_options = {'type': 'default'}
316 # The name of a javascript file (relative to the configuration directory) that
317 # implements a search results scorer. If empty, the default will be used.
318 #html_search_scorer = 'scorer.js'
320 # Output file base name for HTML help builder.
321 htmlhelp_basename = 'TheLinuxKerneldoc'
323 # -- Options for LaTeX output ---------------------------------------------
326 # The paper size ('letterpaper' or 'a4paper').
327 'papersize': 'a4paper',
329 # The font size ('10pt', '11pt' or '12pt').
332 # Latex figure (float) alignment
333 #'figure_align': 'htbp',
335 # Don't mangle with UTF-8 chars
339 # Set document margins
341 hmargin=0.5in, vmargin=1in,
342 parsedliteralwraps=true,
343 verbatimhintsturnover=false,
346 # Additional stuff for the LaTeX preamble.
348 % Prevent column squeezing of tabulary.
349 \\setlength{\\tymin}{20em}
350 % Use some font with UTF-8 support with XeLaTeX
351 \\usepackage{fontspec}
352 \\setsansfont{DejaVu Sans}
353 \\setromanfont{DejaVu Serif}
354 \\setmonofont{DejaVu Sans Mono}
358 # At least one book (translations) may have Asian characters
359 # with are only displayed if xeCJK is used
361 cjk_cmd = check_output(['fc-list', '--format="%{family[0]}\n"']).decode('utf-8', 'ignore')
362 if cjk_cmd.find("Noto Sans CJK SC") >= 0:
363 latex_elements['preamble'] += '''
364 % This is needed for translations
366 \\setCJKmainfont{Noto Sans CJK SC}
367 % Define custom macros to on/off CJK
368 \\newcommand{\\kerneldocCJKon}{\\makexeCJKactive}
369 \\newcommand{\\kerneldocCJKoff}{\\makexeCJKinactive}
370 % To customize \sphinxtableofcontents
371 \\usepackage{etoolbox}
372 % Inactivate CJK after tableofcontents
373 \\apptocmd{\\sphinxtableofcontents}{\\kerneldocCJKoff}{}{}
376 latex_elements['preamble'] += '''
377 % Custom macros to on/off CJK (Dummy)
378 \\newcommand{\\kerneldocCJKon}{}
379 \\newcommand{\\kerneldocCJKoff}{}
382 # Fix reference escape troubles with Sphinx 1.4.x
384 latex_elements['preamble'] += '\\renewcommand*{\\DUrole}[2]{ #2 }\n'
386 # With Sphinx 1.6, it is possible to change the Bg color directly
388 # \definecolor{sphinxnoteBgColor}{RGB}{204,255,255}
389 # \definecolor{sphinxwarningBgColor}{RGB}{255,204,204}
390 # \definecolor{sphinxattentionBgColor}{RGB}{255,255,204}
391 # \definecolor{sphinximportantBgColor}{RGB}{192,255,204}
393 # However, it require to use sphinx heavy box with:
395 # \renewenvironment{sphinxlightbox} {%
396 # \\begin{sphinxheavybox}
398 # \\end{sphinxheavybox}
401 # Unfortunately, the implementation is buggy: if a note is inside a
402 # table, it isn't displayed well. So, for now, let's use boring
403 # black and white notes.
405 # Grouping the document tree into LaTeX files. List of tuples
406 # (source start file, target name, title,
407 # author, documentclass [howto, manual, or own class]).
408 # Sorted in alphabetical order
412 # Add all other index files from Documentation/ subdirectories
413 for fn in os.listdir('.'):
414 doc = os.path.join(fn, "index")
415 if os.path.exists(doc + ".rst"):
417 for l in latex_documents:
422 latex_documents.append((doc, fn + '.tex',
423 'Linux %s Documentation' % fn.capitalize(),
424 'The kernel development community',
427 # The name of an image file (relative to this directory) to place at the top of
431 # For "manual" documents, if this is true, then toplevel headings are parts,
433 #latex_use_parts = False
435 # If true, show page references after internal links.
436 #latex_show_pagerefs = False
438 # If true, show URL addresses after external links.
439 #latex_show_urls = False
441 # Documents to append as an appendix to all manuals.
442 #latex_appendices = []
444 # If false, no module index is generated.
445 #latex_domain_indices = True
448 # -- Options for manual page output ---------------------------------------
450 # One entry per manual page. List of tuples
451 # (source start file, name, description, authors, manual section).
453 (master_doc, 'thelinuxkernel', 'The Linux Kernel Documentation',
457 # If true, show URL addresses after external links.
458 #man_show_urls = False
461 # -- Options for Texinfo output -------------------------------------------
463 # Grouping the document tree into Texinfo files. List of tuples
464 # (source start file, target name, title, author,
465 # dir menu entry, description, category)
466 texinfo_documents = [
467 (master_doc, 'TheLinuxKernel', 'The Linux Kernel Documentation',
468 author, 'TheLinuxKernel', 'One line description of project.',
472 # Documents to append as an appendix to all manuals.
473 #texinfo_appendices = []
475 # If false, no module index is generated.
476 #texinfo_domain_indices = True
478 # How to display URL addresses: 'footnote', 'no', or 'inline'.
479 #texinfo_show_urls = 'footnote'
481 # If true, do not generate a @detailmenu in the "Top" node's menu.
482 #texinfo_no_detailmenu = False
485 # -- Options for Epub output ----------------------------------------------
487 # Bibliographic Dublin Core info.
490 epub_publisher = author
491 epub_copyright = copyright
493 # The basename for the epub file. It defaults to the project name.
494 #epub_basename = project
496 # The HTML theme for the epub output. Since the default themes are not
497 # optimized for small screen space, using the same theme for HTML and epub
498 # output is usually not wise. This defaults to 'epub', a theme designed to save
502 # The language of the text. It defaults to the language option
503 # or 'en' if the language is not set.
506 # The scheme of the identifier. Typical schemes are ISBN or URL.
509 # The unique identifier of the text. This can be a ISBN number
510 # or the project homepage.
511 #epub_identifier = ''
513 # A unique identification for the text.
516 # A tuple containing the cover image and cover page html template filenames.
519 # A sequence of (type, uri, title) tuples for the guide element of content.opf.
522 # HTML files that should be inserted before the pages created by sphinx.
523 # The format is a list of tuples containing the path and title.
526 # HTML files that should be inserted after the pages created by sphinx.
527 # The format is a list of tuples containing the path and title.
528 #epub_post_files = []
530 # A list of files that should not be packed into the epub file.
531 epub_exclude_files = ['search.html']
533 # The depth of the table of contents in toc.ncx.
536 # Allow duplicate toc entries.
539 # Choose between 'default' and 'includehidden'.
540 #epub_tocscope = 'default'
542 # Fix unsupported image types using the Pillow.
543 #epub_fix_images = False
545 # Scale large images.
546 #epub_max_image_width = 0
548 # How to display URL addresses: 'footnote', 'no', or 'inline'.
549 #epub_show_urls = 'inline'
551 # If false, no index is generated.
552 #epub_use_index = True
557 # Grouping the document tree into PDF files. List of tuples
558 # (source start file, target name, title, author, options).
560 # See the Sphinx chapter of https://ralsina.me/static/manual.pdf
562 # FIXME: Do not add the index file here; the result will be too big. Adding
563 # multiple PDF files here actually tries to get the cross-referencing right
564 # *between* PDF files.
566 ('kernel-documentation', u'Kernel', u'Kernel', u'J. Random Bozo'),
569 # kernel-doc extension configuration for running Sphinx directly (e.g. by Read
570 # the Docs). In a normal build, these are supplied from the Makefile via command
572 kerneldoc_bin = '../scripts/kernel-doc'
573 kerneldoc_srctree = '..'
575 # ------------------------------------------------------------------------------
576 # Since loadConfig overwrites settings from the global namespace, it has to be
577 # the last statement in the conf.py file
578 # ------------------------------------------------------------------------------
579 loadConfig(globals())