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
  19 from subprocess import check_output
  20
  21 # Get Sphinx version
  22 major, minor, patch = sphinx.version_info[:3]
  23
  24
  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
  30
  31 # -- General configuration ------------------------------------------------
  32
  33 # If your documentation needs a minimal Sphinx version, state it here.
  34 needs_sphinx = '1.3'
  35
  36 # Add any Sphinx extension module names here, as strings. They can be
  37 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
  38 # ones.
  39 extensions = ['kerneldoc', 'rstFlatTable', 'kernel_include', 'cdomain',
  40               'kfigure', 'sphinx.ext.ifconfig', 'automarkup',
  41               'maintainers_include', 'sphinx.ext.autosectionlabel' ]
  42
  43 # Ensure that autosectionlabel will produce unique names
  44 autosectionlabel_prefix_document = True
  45 autosectionlabel_maxdepth = 2
  46
  47 # The name of the math extension changed on Sphinx 1.4
  48 if (major == 1 and minor > 3) or (major > 1):
  49     extensions.append("sphinx.ext.imgmath")
  50 else:
  51     extensions.append("sphinx.ext.pngmath")
  52
  53 # Add any paths that contain templates here, relative to this directory.
  54 templates_path = ['_templates']
  55
  56 # The suffix(es) of source filenames.
  57 # You can specify multiple suffix as a list of string:
  58 # source_suffix = ['.rst', '.md']
  59 source_suffix = '.rst'
  60
  61 # The encoding of source files.
  62 #source_encoding = 'utf-8-sig'
  63
  64 # The master toctree document.
  65 master_doc = 'index'
  66
  67 # General information about the project.
  68 project = 'The Linux Kernel'
  69 copyright = 'The kernel development community'
  70 author = 'The kernel development community'
  71
  72 # The version info for the project you're documenting, acts as replacement for
  73 # |version| and |release|, also used in various other places throughout the
  74 # built documents.
  75 #
  76 # In a normal build, version and release are are set to KERNELVERSION and
  77 # KERNELRELEASE, respectively, from the Makefile via Sphinx command line
  78 # arguments.
  79 #
  80 # The following code tries to extract the information by reading the Makefile,
  81 # when Sphinx is run directly (e.g. by Read the Docs).
  82 try:
  83     makefile_version = None
  84     makefile_patchlevel = None
  85     for line in open('../Makefile'):
  86         key, val = [x.strip() for x in line.split('=', 2)]
  87         if key == 'VERSION':
  88             makefile_version = val
  89         elif key == 'PATCHLEVEL':
  90             makefile_patchlevel = val
  91         if makefile_version and makefile_patchlevel:
  92             break
  93 except:
  94     pass
  95 finally:
  96     if makefile_version and makefile_patchlevel:
  97         version = release = makefile_version + '.' + makefile_patchlevel
  98     else:
  99         version = release = "unknown version"
 100
 101 # The language for content autogenerated by Sphinx. Refer to documentation
 102 # for a list of supported languages.
 103 #
 104 # This is also used if you do content translation via gettext catalogs.
 105 # Usually you set "language" from the command line for these cases.
 106 language = None
 107
 108 # There are two options for replacing |today|: either, you set today to some
 109 # non-false value, then it is used:
 110 #today = ''
 111 # Else, today_fmt is used as the format for a strftime call.
 112 #today_fmt = '%B %d, %Y'
 113
 114 # List of patterns, relative to source directory, that match files and
 115 # directories to ignore when looking for source files.
 116 exclude_patterns = ['output']
 117
 118 # The reST default role (used for this markup: `text`) to use for all
 119 # documents.
 120 #default_role = None
 121
 122 # If true, '()' will be appended to :func: etc. cross-reference text.
 123 #add_function_parentheses = True
 124
 125 # If true, the current module name will be prepended to all description
 126 # unit titles (such as .. function::).
 127 #add_module_names = True
 128
 129 # If true, sectionauthor and moduleauthor directives will be shown in the
 130 # output. They are ignored by default.
 131 #show_authors = False
 132
 133 # The name of the Pygments (syntax highlighting) style to use.
 134 pygments_style = 'sphinx'
 135
 136 # A list of ignored prefixes for module index sorting.
 137 #modindex_common_prefix = []
 138
 139 # If true, keep warnings as "system message" paragraphs in the built documents.
 140 #keep_warnings = False
 141
 142 # If true, `todo` and `todoList` produce output, else they produce nothing.
 143 todo_include_todos = False
 144
 145 primary_domain = 'c'
 146 highlight_language = 'none'
 147
 148 # -- Options for HTML output ----------------------------------------------
 149
 150 # The theme to use for HTML and HTML Help pages.  See the documentation for
 151 # a list of builtin themes.
 152
 153 # The Read the Docs theme is available from
 154 # - https://github.com/snide/sphinx_rtd_theme
 155 # - https://pypi.python.org/pypi/sphinx_rtd_theme
 156 # - python-sphinx-rtd-theme package (on Debian)
 157 try:
 158     import sphinx_rtd_theme
 159     html_theme = 'sphinx_rtd_theme'
 160     html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 161 except ImportError:
 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')
 163
 164 # Theme options are theme-specific and customize the look and feel of a theme
 165 # further.  For a list of options available for each theme, see the
 166 # documentation.
 167 #html_theme_options = {}
 168
 169 # Add any paths that contain custom themes here, relative to this directory.
 170 #html_theme_path = []
 171
 172 # The name for this set of Sphinx documents.  If None, it defaults to
 173 # "<project> v<release> documentation".
 174 #html_title = None
 175
 176 # A shorter title for the navigation bar.  Default is the same as html_title.
 177 #html_short_title = None
 178
 179 # The name of an image file (relative to this directory) to place at the top
 180 # of the sidebar.
 181 #html_logo = None
 182
 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
 187
 188 # Add any paths that contain custom static files (such as style sheets) here,
 189 # relative to this directory. They are copied after the builtin static files,
 190 # so a file named "default.css" will overwrite the builtin "default.css".
 191
 192 html_static_path = ['sphinx-static']
 193
 194 html_context = {
 195     'css_files': [
 196         '_static/theme_overrides.css',
 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
 212
 213 # Custom sidebar templates, maps document names to template names.
 214 #html_sidebars = {}
 215
 216 # Additional templates that should be rendered to pages, maps page names to
 217 # template names.
 218 #html_additional_pages = {}
 219
 220 # If false, no module index is generated.
 221 #html_domain_indices = True
 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'
 259
 260 # Output file base name for HTML help builder.
 261 htmlhelp_basename = 'TheLinuxKerneldoc'
 262
 263 # -- Options for LaTeX output ---------------------------------------------
 264
 265 latex_elements = {
 266 # The paper size ('letterpaper' or 'a4paper').
 267 'papersize': 'a4paper',
 268
 269 # The font size ('10pt', '11pt' or '12pt').
 270 'pointsize': '11pt',
 271
 272 # Latex figure (float) alignment
 273 #'figure_align': 'htbp',
 274
 275 # Don't mangle with UTF-8 chars
 276 'inputenc': '',
 277 'utf8extra': '',
 278
 279 # Additional stuff for the LaTeX preamble.
 280     'preamble': '''
 281         % Use some font with UTF-8 support with XeLaTeX
 282         \\usepackage{fontspec}
 283         \\setsansfont{DejaVu Sans}
 284         \\setromanfont{DejaVu Serif}
 285         \\setmonofont{DejaVu Sans Mono}
 286      '''
 287 }
 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
 301 # Fix reference escape troubles with Sphinx 1.4.x
 302 if major == 1 and minor > 3:
 303     latex_elements['preamble']  += '\\renewcommand*{\\DUrole}[2]{ #2 }\n'
 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
 364
 365      '''
 366
 367 # With Sphinx 1.6, it is possible to change the Bg color directly
 368 # by using:
 369 #       \definecolor{sphinxnoteBgColor}{RGB}{204,255,255}
 370 #       \definecolor{sphinxwarningBgColor}{RGB}{255,204,204}
 371 #       \definecolor{sphinxattentionBgColor}{RGB}{255,255,204}
 372 #       \definecolor{sphinximportantBgColor}{RGB}{192,255,204}
 373 #
 374 # However, it require to use sphinx heavy box with:
 375 #
 376 #       \renewenvironment{sphinxlightbox} {%
 377 #               \\begin{sphinxheavybox}
 378 #       }
 379 #               \\end{sphinxheavybox}
 380 #       }
 381 #
 382 # Unfortunately, the implementation is buggy: if a note is inside a
 383 # table, it isn't displayed well. So, for now, let's use boring
 384 # black and white notes.
 385
 386 # Grouping the document tree into LaTeX files. List of tuples
 387 # (source start file, target name, title,
 388 #  author, documentclass [howto, manual, or own class]).
 389 # Sorted in alphabetical order
 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'),
 429 ]
 430
 431 # Add all other index files from Documentation/ subdirectories
 432 for fn in os.listdir('.'):
 433     doc = os.path.join(fn, "index")
 434     if os.path.exists(doc + ".rst"):
 435         has = False
 436         for l in latex_documents:
 437             if l[0] == doc:
 438                 has = True
 439                 break
 440         if not has:
 441             latex_documents.append((doc, fn + '.tex',
 442                                     'Linux %s Documentation' % fn.capitalize(),
 443                                     'The kernel development community',
 444                                     'manual'))
 445
 446 # The name of an image file (relative to this directory) to place at the top of
 447 # the title page.
 448 #latex_logo = None
 449
 450 # For "manual" documents, if this is true, then toplevel headings are parts,
 451 # not chapters.
 452 #latex_use_parts = False
 453
 454 # If true, show page references after internal links.
 455 #latex_show_pagerefs = False
 456
 457 # If true, show URL addresses after external links.
 458 #latex_show_urls = False
 459
 460 # Documents to append as an appendix to all manuals.
 461 #latex_appendices = []
 462
 463 # If false, no module index is generated.
 464 #latex_domain_indices = True
 465
 466
 467 # -- Options for manual page output ---------------------------------------
 468
 469 # One entry per manual page. List of tuples
 470 # (source start file, name, description, authors, manual section).
 471 man_pages = [
 472     (master_doc, 'thelinuxkernel', 'The Linux Kernel Documentation',
 473      [author], 1)
 474 ]
 475
 476 # If true, show URL addresses after external links.
 477 #man_show_urls = False
 478
 479
 480 # -- Options for Texinfo output -------------------------------------------
 481
 482 # Grouping the document tree into Texinfo files. List of tuples
 483 # (source start file, target name, title, author,
 484 #  dir menu entry, description, category)
 485 texinfo_documents = [
 486     (master_doc, 'TheLinuxKernel', 'The Linux Kernel Documentation',
 487      author, 'TheLinuxKernel', 'One line description of project.',
 488      'Miscellaneous'),
 489 ]
 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
 504 # -- Options for Epub output ----------------------------------------------
 505
 506 # Bibliographic Dublin Core info.
 507 epub_title = project
 508 epub_author = author
 509 epub_publisher = author
 510 epub_copyright = copyright
 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
 549 # A list of files that should not be packed into the epub file.
 550 epub_exclude_files = ['search.html']
 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
 573 #=======
 574 # rst2pdf
 575 #
 576 # Grouping the document tree into PDF files. List of tuples
 577 # (source start file, target name, title, author, options).
 578 #
 579 # See the Sphinx chapter of http://ralsina.me/static/manual.pdf
 580 #
 581 # FIXME: Do not add the index file here; the result will be too big. Adding
 582 # multiple PDF files here actually tries to get the cross-referencing right
 583 # *between* PDF files.
 584 pdf_documents = [
 585     ('kernel-documentation', u'Kernel', u'Kernel', u'J. Random Bozo'),
 586 ]
 587
 588 # kernel-doc extension configuration for running Sphinx directly (e.g. by Read
 589 # the Docs). In a normal build, these are supplied from the Makefile via command
 590 # line arguments.
 591 kerneldoc_bin = '../scripts/kernel-doc'
 592 kerneldoc_srctree = '..'
 593
 594 # ------------------------------------------------------------------------------
 595 # Since loadConfig overwrites settings from the global namespace, it has to be
 596 # the last statement in the conf.py file
 597 # ------------------------------------------------------------------------------
 598 loadConfig(globals())