Documentation/conf.py

   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
  17 import sphinx
  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
  30
  31 # Get Sphinx version
  32 major, 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 #
  38 if (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.
  44 sys.path.insert(0, os.path.abspath('sphinx'))
  45 from load_config import loadConfig
  46
  47 # -- General configuration ------------------------------------------------
  48
  49 # If your documentation needs a minimal Sphinx version, state it here.
  50 needs_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.
  55 extensions = ['kerneldoc', 'rstFlatTable', 'kernel_include',
  56               'kfigure', 'sphinx.ext.ifconfig', 'automarkup',
  57               'maintainers_include', 'sphinx.ext.autosectionlabel',
  58               'kernel_abi', 'kernel_feat']
  59
  60 if 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
 124 else:
 125     extensions.append('cdomain')
 126
 127 # Ensure that autosectionlabel will produce unique names
 128 autosectionlabel_prefix_document = True
 129 autosectionlabel_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.
 134 have_latex =  have_command('latex')
 135 have_dvipng = have_command('dvipng')
 136 load_imgmath = have_latex and have_dvipng
 137
 138 # Respect SPHINX_IMGMATH (for html docs only)
 139 if '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
 149 load_imgmath = (load_imgmath or (major == 1 and minor < 8)
 150                 or 'epub' in sys.argv)
 151
 152 if load_imgmath:
 153     extensions.append("sphinx.ext.imgmath")
 154     math_renderer = 'imgmath'
 155 else:
 156     math_renderer = 'mathjax'
 157
 158 # Add any paths that contain templates here, relative to this directory.
 159 templates_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']
 164 source_suffix = '.rst'
 165
 166 # The encoding of source files.
 167 #source_encoding = 'utf-8-sig'
 168
 169 # The master toctree document.
 170 master_doc = 'index'
 171
 172 # General information about the project.
 173 project = 'The Linux Kernel'
 174 copyright = 'The kernel development community'
 175 author = '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).
 187 try:
 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
 198 except:
 199     pass
 200 finally:
 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 #
 211 def 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.
 229 language = '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.
 239 exclude_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.
 257 pygments_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.
 266 todo_include_todos = False
 267
 268 primary_domain = 'c'
 269 highlight_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
 277 html_theme = 'alabaster'
 278 html_css_files = []
 279
 280 if "DOCS_THEME" in os.environ:
 281     html_theme = os.environ["DOCS_THEME"]
 282
 283 if 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
 315 if "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
 321 if 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
 329 if  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
 339 sys.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".
 344 html_static_path = ['sphinx-static']
 345
 346 # If true, Docutils "smart quotes" will be used to convert quotes and dashes
 347 # to typographically correct entities.  This will convert "--" to "—",
 348 # which is not always what we want, so disable it.
 349 smartquotes = False
 350
 351 # Custom sidebar templates, maps document names to template names.
 352 # Note that the RTD theme ignores this
 353 html_sidebars = { '**': ['searchbox.html', 'kernel-toc.html', 'sourcelink.html']}
 354
 355 # about.html is available for alabaster theme. Add it at the front.
 356 if html_theme == 'alabaster':
 357     html_sidebars['**'].insert(0, 'about.html')
 358
 359 # Output file base name for HTML help builder.
 360 htmlhelp_basename = 'TheLinuxKerneldoc'
 361
 362 # -- Options for LaTeX output ---------------------------------------------
 363
 364 latex_elements = {
 365     # The paper size ('letterpaper' or 'a4paper').
 366     'papersize': 'a4paper',
 367
 368     # The font size ('10pt', '11pt' or '12pt').
 369     'pointsize': '11pt',
 370
 371     # Latex figure (float) alignment
 372     #'figure_align': 'htbp',
 373
 374     # Don't mangle with UTF-8 chars
 375     'inputenc': '',
 376     'utf8extra': '',
 377
 378     # Set document margins
 379     'sphinxsetup': '''
 380         hmargin=0.5in, vmargin=1in,
 381         parsedliteralwraps=true,
 382         verbatimhintsturnover=false,
 383     ''',
 384
 385     # For CJK One-half spacing, need to be in front of hyperref
 386     'extrapackages': r'\usepackage{setspace}',
 387
 388     # Additional stuff for the LaTeX preamble.
 389     'preamble': '''
 390         % Use some font with UTF-8 support with XeLaTeX
 391         \\usepackage{fontspec}
 392         \\setsansfont{DejaVu Sans}
 393         \\setromanfont{DejaVu Serif}
 394         \\setmonofont{DejaVu Sans Mono}
 395     ''',
 396 }
 397
 398 # Fix reference escape troubles with Sphinx 1.4.x
 399 if major == 1:
 400     latex_elements['preamble']  += '\\renewcommand*{\\DUrole}[2]{ #2 }\n'
 401
 402
 403 # Load kerneldoc specific LaTeX settings
 404 latex_elements['preamble'] += '''
 405         % Load kerneldoc specific LaTeX settings
 406         \\input{kerneldoc-preamble.sty}
 407 '''
 408
 409 # With Sphinx 1.6, it is possible to change the Bg color directly
 410 # by using:
 411 #       \definecolor{sphinxnoteBgColor}{RGB}{204,255,255}
 412 #       \definecolor{sphinxwarningBgColor}{RGB}{255,204,204}
 413 #       \definecolor{sphinxattentionBgColor}{RGB}{255,255,204}
 414 #       \definecolor{sphinximportantBgColor}{RGB}{192,255,204}
 415 #
 416 # However, it require to use sphinx heavy box with:
 417 #
 418 #       \renewenvironment{sphinxlightbox} {%
 419 #               \\begin{sphinxheavybox}
 420 #       }
 421 #               \\end{sphinxheavybox}
 422 #       }
 423 #
 424 # Unfortunately, the implementation is buggy: if a note is inside a
 425 # table, it isn't displayed well. So, for now, let's use boring
 426 # black and white notes.
 427
 428 # Grouping the document tree into LaTeX files. List of tuples
 429 # (source start file, target name, title,
 430 #  author, documentclass [howto, manual, or own class]).
 431 # Sorted in alphabetical order
 432 latex_documents = [
 433 ]
 434
 435 # Add all other index files from Documentation/ subdirectories
 436 for fn in os.listdir('.'):
 437     doc = os.path.join(fn, "index")
 438     if os.path.exists(doc + ".rst"):
 439         has = False
 440         for l in latex_documents:
 441             if l[0] == doc:
 442                 has = True
 443                 break
 444         if not has:
 445             latex_documents.append((doc, fn + '.tex',
 446                                     'Linux %s Documentation' % fn.capitalize(),
 447                                     'The kernel development community',
 448                                     'manual'))
 449
 450 # The name of an image file (relative to this directory) to place at the top of
 451 # the title page.
 452 #latex_logo = None
 453
 454 # For "manual" documents, if this is true, then toplevel headings are parts,
 455 # not chapters.
 456 #latex_use_parts = False
 457
 458 # If true, show page references after internal links.
 459 #latex_show_pagerefs = False
 460
 461 # If true, show URL addresses after external links.
 462 #latex_show_urls = False
 463
 464 # Documents to append as an appendix to all manuals.
 465 #latex_appendices = []
 466
 467 # If false, no module index is generated.
 468 #latex_domain_indices = True
 469
 470 # Additional LaTeX stuff to be copied to build directory
 471 latex_additional_files = [
 472     'sphinx/kerneldoc-preamble.sty',
 473 ]
 474
 475
 476 # -- Options for manual page output ---------------------------------------
 477
 478 # One entry per manual page. List of tuples
 479 # (source start file, name, description, authors, manual section).
 480 man_pages = [
 481     (master_doc, 'thelinuxkernel', 'The Linux Kernel Documentation',
 482      [author], 1)
 483 ]
 484
 485 # If true, show URL addresses after external links.
 486 #man_show_urls = False
 487
 488
 489 # -- Options for Texinfo output -------------------------------------------
 490
 491 # Grouping the document tree into Texinfo files. List of tuples
 492 # (source start file, target name, title, author,
 493 #  dir menu entry, description, category)
 494 texinfo_documents = [
 495     (master_doc, 'TheLinuxKernel', 'The Linux Kernel Documentation',
 496      author, 'TheLinuxKernel', 'One line description of project.',
 497      'Miscellaneous'),
 498 ]
 499
 500 # -- Options for Epub output ----------------------------------------------
 501
 502 # Bibliographic Dublin Core info.
 503 epub_title = project
 504 epub_author = author
 505 epub_publisher = author
 506 epub_copyright = copyright
 507
 508 # A list of files that should not be packed into the epub file.
 509 epub_exclude_files = ['search.html']
 510
 511 #=======
 512 # rst2pdf
 513 #
 514 # Grouping the document tree into PDF files. List of tuples
 515 # (source start file, target name, title, author, options).
 516 #
 517 # See the Sphinx chapter of https://ralsina.me/static/manual.pdf
 518 #
 519 # FIXME: Do not add the index file here; the result will be too big. Adding
 520 # multiple PDF files here actually tries to get the cross-referencing right
 521 # *between* PDF files.
 522 pdf_documents = [
 523     ('kernel-documentation', u'Kernel', u'Kernel', u'J. Random Bozo'),
 524 ]
 525
 526 # kernel-doc extension configuration for running Sphinx directly (e.g. by Read
 527 # the Docs). In a normal build, these are supplied from the Makefile via command
 528 # line arguments.
 529 kerneldoc_bin = '../scripts/kernel-doc'
 530 kerneldoc_srctree = '..'
 531
 532 # ------------------------------------------------------------------------------
 533 # Since loadConfig overwrites settings from the global namespace, it has to be
 534 # the last statement in the conf.py file
 535 # ------------------------------------------------------------------------------
 536 loadConfig(globals())