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