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 # Get Sphinx version
  20 major, minor, patch = sphinx.version_info[:3]
  21
  22
  23 # If extensions (or modules to document with autodoc) are in another directory,
  24 # add these directories to sys.path here. If the directory is relative to the
  25 # documentation root, use os.path.abspath to make it absolute, like shown here.
  26 sys.path.insert(0, os.path.abspath('sphinx'))
  27 from load_config import loadConfig
  28
  29 # -- General configuration ------------------------------------------------
  30
  31 # If your documentation needs a minimal Sphinx version, state it here.
  32 needs_sphinx = '1.2'
  33
  34 # Add any Sphinx extension module names here, as strings. They can be
  35 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
  36 # ones.
  37 extensions = ['kerneldoc', 'rstFlatTable', 'kernel_include', 'cdomain', 'kfigure']
  38
  39 # The name of the math extension changed on Sphinx 1.4
  40 if major == 1 and minor > 3:
  41     extensions.append("sphinx.ext.imgmath")
  42 else:
  43     extensions.append("sphinx.ext.pngmath")
  44
  45 # Add any paths that contain templates here, relative to this directory.
  46 templates_path = ['_templates']
  47
  48 # The suffix(es) of source filenames.
  49 # You can specify multiple suffix as a list of string:
  50 # source_suffix = ['.rst', '.md']
  51 source_suffix = '.rst'
  52
  53 # The encoding of source files.
  54 #source_encoding = 'utf-8-sig'
  55
  56 # The master toctree document.
  57 master_doc = 'index'
  58
  59 # General information about the project.
  60 project = 'The Linux Kernel'
  61 copyright = 'The kernel development community'
  62 author = 'The kernel development community'
  63
  64 # The version info for the project you're documenting, acts as replacement for
  65 # |version| and |release|, also used in various other places throughout the
  66 # built documents.
  67 #
  68 # In a normal build, version and release are are set to KERNELVERSION and
  69 # KERNELRELEASE, respectively, from the Makefile via Sphinx command line
  70 # arguments.
  71 #
  72 # The following code tries to extract the information by reading the Makefile,
  73 # when Sphinx is run directly (e.g. by Read the Docs).
  74 try:
  75     makefile_version = None
  76     makefile_patchlevel = None
  77     for line in open('../Makefile'):
  78         key, val = [x.strip() for x in line.split('=', 2)]
  79         if key == 'VERSION':
  80             makefile_version = val
  81         elif key == 'PATCHLEVEL':
  82             makefile_patchlevel = val
  83         if makefile_version and makefile_patchlevel:
  84             break
  85 except:
  86     pass
  87 finally:
  88     if makefile_version and makefile_patchlevel:
  89         version = release = makefile_version + '.' + makefile_patchlevel
  90     else:
  91         sys.stderr.write('Warning: Could not extract kernel version\n')
  92         version = release = "unknown version"
  93
  94 # The language for content autogenerated by Sphinx. Refer to documentation
  95 # for a list of supported languages.
  96 #
  97 # This is also used if you do content translation via gettext catalogs.
  98 # Usually you set "language" from the command line for these cases.
  99 language = None
 100
 101 # There are two options for replacing |today|: either, you set today to some
 102 # non-false value, then it is used:
 103 #today = ''
 104 # Else, today_fmt is used as the format for a strftime call.
 105 #today_fmt = '%B %d, %Y'
 106
 107 # List of patterns, relative to source directory, that match files and
 108 # directories to ignore when looking for source files.
 109 exclude_patterns = ['output']
 110
 111 # The reST default role (used for this markup: `text`) to use for all
 112 # documents.
 113 #default_role = None
 114
 115 # If true, '()' will be appended to :func: etc. cross-reference text.
 116 #add_function_parentheses = True
 117
 118 # If true, the current module name will be prepended to all description
 119 # unit titles (such as .. function::).
 120 #add_module_names = True
 121
 122 # If true, sectionauthor and moduleauthor directives will be shown in the
 123 # output. They are ignored by default.
 124 #show_authors = False
 125
 126 # The name of the Pygments (syntax highlighting) style to use.
 127 pygments_style = 'sphinx'
 128
 129 # A list of ignored prefixes for module index sorting.
 130 #modindex_common_prefix = []
 131
 132 # If true, keep warnings as "system message" paragraphs in the built documents.
 133 #keep_warnings = False
 134
 135 # If true, `todo` and `todoList` produce output, else they produce nothing.
 136 todo_include_todos = False
 137
 138 primary_domain = 'c'
 139 highlight_language = 'none'
 140
 141 # -- Options for HTML output ----------------------------------------------
 142
 143 # The theme to use for HTML and HTML Help pages.  See the documentation for
 144 # a list of builtin themes.
 145
 146 # The Read the Docs theme is available from
 147 # - https://github.com/snide/sphinx_rtd_theme
 148 # - https://pypi.python.org/pypi/sphinx_rtd_theme
 149 # - python-sphinx-rtd-theme package (on Debian)
 150 try:
 151     import sphinx_rtd_theme
 152     html_theme = 'sphinx_rtd_theme'
 153     html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 154 except ImportError:
 155     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')
 156
 157 # Theme options are theme-specific and customize the look and feel of a theme
 158 # further.  For a list of options available for each theme, see the
 159 # documentation.
 160 #html_theme_options = {}
 161
 162 # Add any paths that contain custom themes here, relative to this directory.
 163 #html_theme_path = []
 164
 165 # The name for this set of Sphinx documents.  If None, it defaults to
 166 # "<project> v<release> documentation".
 167 #html_title = None
 168
 169 # A shorter title for the navigation bar.  Default is the same as html_title.
 170 #html_short_title = None
 171
 172 # The name of an image file (relative to this directory) to place at the top
 173 # of the sidebar.
 174 #html_logo = None
 175
 176 # The name of an image file (within the static path) to use as favicon of the
 177 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 178 # pixels large.
 179 #html_favicon = None
 180
 181 # Add any paths that contain custom static files (such as style sheets) here,
 182 # relative to this directory. They are copied after the builtin static files,
 183 # so a file named "default.css" will overwrite the builtin "default.css".
 184
 185 html_static_path = ['sphinx-static']
 186
 187 html_context = {
 188     'css_files': [
 189         '_static/theme_overrides.css',
 190     ],
 191 }
 192
 193 # Add any extra paths that contain custom files (such as robots.txt or
 194 # .htaccess) here, relative to this directory. These files are copied
 195 # directly to the root of the documentation.
 196 #html_extra_path = []
 197
 198 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 199 # using the given strftime format.
 200 #html_last_updated_fmt = '%b %d, %Y'
 201
 202 # If true, SmartyPants will be used to convert quotes and dashes to
 203 # typographically correct entities.
 204 #html_use_smartypants = True
 205
 206 # Custom sidebar templates, maps document names to template names.
 207 #html_sidebars = {}
 208
 209 # Additional templates that should be rendered to pages, maps page names to
 210 # template names.
 211 #html_additional_pages = {}
 212
 213 # If false, no module index is generated.
 214 #html_domain_indices = True
 215
 216 # If false, no index is generated.
 217 #html_use_index = True
 218
 219 # If true, the index is split into individual pages for each letter.
 220 #html_split_index = False
 221
 222 # If true, links to the reST sources are added to the pages.
 223 #html_show_sourcelink = True
 224
 225 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
 226 #html_show_sphinx = True
 227
 228 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
 229 #html_show_copyright = True
 230
 231 # If true, an OpenSearch description file will be output, and all pages will
 232 # contain a <link> tag referring to it.  The value of this option must be the
 233 # base URL from which the finished HTML is served.
 234 #html_use_opensearch = ''
 235
 236 # This is the file name suffix for HTML files (e.g. ".xhtml").
 237 #html_file_suffix = None
 238
 239 # Language to be used for generating the HTML full-text search index.
 240 # Sphinx supports the following languages:
 241 #   'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja'
 242 #   'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr'
 243 #html_search_language = 'en'
 244
 245 # A dictionary with options for the search language support, empty by default.
 246 # Now only 'ja' uses this config value
 247 #html_search_options = {'type': 'default'}
 248
 249 # The name of a javascript file (relative to the configuration directory) that
 250 # implements a search results scorer. If empty, the default will be used.
 251 #html_search_scorer = 'scorer.js'
 252
 253 # Output file base name for HTML help builder.
 254 htmlhelp_basename = 'TheLinuxKerneldoc'
 255
 256 # -- Options for LaTeX output ---------------------------------------------
 257
 258 latex_elements = {
 259 # The paper size ('letterpaper' or 'a4paper').
 260 'papersize': 'a4paper',
 261
 262 # The font size ('10pt', '11pt' or '12pt').
 263 'pointsize': '8pt',
 264
 265 # Latex figure (float) alignment
 266 #'figure_align': 'htbp',
 267
 268 # Don't mangle with UTF-8 chars
 269 'inputenc': '',
 270 'utf8extra': '',
 271
 272 # Additional stuff for the LaTeX preamble.
 273     'preamble': '''
 274         \\usepackage{ifthen}
 275
 276         % Allow generate some pages in landscape
 277         \\usepackage{lscape}
 278
 279         % Put notes in color and let them be inside a table
 280         \\definecolor{NoteColor}{RGB}{204,255,255}
 281         \\definecolor{WarningColor}{RGB}{255,204,204}
 282         \\definecolor{AttentionColor}{RGB}{255,255,204}
 283         \\definecolor{ImportantColor}{RGB}{192,255,204}
 284         \\definecolor{OtherColor}{RGB}{204,204,204}
 285         \\newlength{\\mynoticelength}
 286         \\makeatletter\\newenvironment{coloredbox}[1]{%
 287            \\setlength{\\fboxrule}{1pt}
 288            \\setlength{\\fboxsep}{7pt}
 289            \\setlength{\\mynoticelength}{\\linewidth}
 290            \\addtolength{\\mynoticelength}{-2\\fboxsep}
 291            \\addtolength{\\mynoticelength}{-2\\fboxrule}
 292            \\begin{lrbox}{\\@tempboxa}\\begin{minipage}{\\mynoticelength}}{\\end{minipage}\\end{lrbox}%
 293            \\ifthenelse%
 294               {\\equal{\\py@noticetype}{note}}%
 295               {\\colorbox{NoteColor}{\\usebox{\\@tempboxa}}}%
 296               {%
 297                  \\ifthenelse%
 298                  {\\equal{\\py@noticetype}{warning}}%
 299                  {\\colorbox{WarningColor}{\\usebox{\\@tempboxa}}}%
 300                  {%
 301                     \\ifthenelse%
 302                     {\\equal{\\py@noticetype}{attention}}%
 303                     {\\colorbox{AttentionColor}{\\usebox{\\@tempboxa}}}%
 304                     {%
 305                        \\ifthenelse%
 306                        {\\equal{\\py@noticetype}{important}}%
 307                        {\\colorbox{ImportantColor}{\\usebox{\\@tempboxa}}}%
 308                        {\\colorbox{OtherColor}{\\usebox{\\@tempboxa}}}%
 309                     }%
 310                  }%
 311               }%
 312         }\\makeatother
 313
 314         \\makeatletter
 315         \\renewenvironment{notice}[2]{%
 316           \\def\\py@noticetype{#1}
 317           \\begin{coloredbox}{#1}
 318           \\bf\\it
 319           \\par\\strong{#2}
 320           \\csname py@noticestart@#1\\endcsname
 321         }
 322         {
 323           \\csname py@noticeend@\\py@noticetype\\endcsname
 324           \\end{coloredbox}
 325         }
 326         \\makeatother
 327
 328         % Use some font with UTF-8 support with XeLaTeX
 329         \\usepackage{fontspec}
 330         \\setsansfont{DejaVu Serif}
 331         \\setromanfont{DejaVu Sans}
 332         \\setmonofont{DejaVu Sans Mono}
 333
 334         % To allow adjusting table sizes
 335         \\usepackage{adjustbox}
 336
 337      '''
 338 }
 339
 340 # Fix reference escape troubles with Sphinx 1.4.x
 341 if major == 1 and minor > 3:
 342     latex_elements['preamble']  += '\\renewcommand*{\\DUrole}[2]{ #2 }\n'
 343
 344 if major == 1 and minor <= 4:
 345     latex_elements['preamble']  += '\\usepackage[margin=0.5in, top=1in, bottom=1in]{geometry}'
 346 elif major == 1 and (minor > 5 or (minor == 5 and patch >= 3)):
 347     latex_elements['sphinxsetup'] = 'hmargin=0.5in, vmargin=0.5in'
 348
 349
 350 # Grouping the document tree into LaTeX files. List of tuples
 351 # (source start file, target name, title,
 352 #  author, documentclass [howto, manual, or own class]).
 353 # Sorted in alphabetical order
 354 latex_documents = [
 355     ('admin-guide/index', 'linux-user.tex', 'Linux Kernel User Documentation',
 356      'The kernel development community', 'manual'),
 357     ('core-api/index', 'core-api.tex', 'The kernel core API manual',
 358      'The kernel development community', 'manual'),
 359     ('crypto/index', 'crypto-api.tex', 'Linux Kernel Crypto API manual',
 360      'The kernel development community', 'manual'),
 361     ('dev-tools/index', 'dev-tools.tex', 'Development tools for the Kernel',
 362      'The kernel development community', 'manual'),
 363     ('doc-guide/index', 'kernel-doc-guide.tex', 'Linux Kernel Documentation Guide',
 364      'The kernel development community', 'manual'),
 365     ('driver-api/index', 'driver-api.tex', 'The kernel driver API manual',
 366      'The kernel development community', 'manual'),
 367     ('filesystems/index', 'filesystems.tex', 'Linux Filesystems API',
 368      'The kernel development community', 'manual'),
 369     ('gpu/index', 'gpu.tex', 'Linux GPU Driver Developer\'s Guide',
 370      'The kernel development community', 'manual'),
 371     ('input/index', 'linux-input.tex', 'The Linux input driver subsystem',
 372      'The kernel development community', 'manual'),
 373     ('kernel-hacking/index', 'kernel-hacking.tex', 'Unreliable Guide To Hacking The Linux Kernel',
 374      'The kernel development community', 'manual'),
 375     ('media/index', 'media.tex', 'Linux Media Subsystem Documentation',
 376      'The kernel development community', 'manual'),
 377     ('networking/index', 'networking.tex', 'Linux Networking Documentation',
 378      'The kernel development community', 'manual'),
 379     ('process/index', 'development-process.tex', 'Linux Kernel Development Documentation',
 380      'The kernel development community', 'manual'),
 381     ('security/index', 'security.tex', 'The kernel security subsystem manual',
 382      'The kernel development community', 'manual'),
 383     ('sh/index', 'sh.tex', 'SuperH architecture implementation manual',
 384      'The kernel development community', 'manual'),
 385     ('sound/index', 'sound.tex', 'Linux Sound Subsystem Documentation',
 386      'The kernel development community', 'manual'),
 387     ('userspace-api/index', 'userspace-api.tex', 'The Linux kernel user-space API guide',
 388      'The kernel development community', 'manual'),
 389 ]
 390
 391 # The name of an image file (relative to this directory) to place at the top of
 392 # the title page.
 393 #latex_logo = None
 394
 395 # For "manual" documents, if this is true, then toplevel headings are parts,
 396 # not chapters.
 397 #latex_use_parts = False
 398
 399 # If true, show page references after internal links.
 400 #latex_show_pagerefs = False
 401
 402 # If true, show URL addresses after external links.
 403 #latex_show_urls = False
 404
 405 # Documents to append as an appendix to all manuals.
 406 #latex_appendices = []
 407
 408 # If false, no module index is generated.
 409 #latex_domain_indices = True
 410
 411
 412 # -- Options for manual page output ---------------------------------------
 413
 414 # One entry per manual page. List of tuples
 415 # (source start file, name, description, authors, manual section).
 416 man_pages = [
 417     (master_doc, 'thelinuxkernel', 'The Linux Kernel Documentation',
 418      [author], 1)
 419 ]
 420
 421 # If true, show URL addresses after external links.
 422 #man_show_urls = False
 423
 424
 425 # -- Options for Texinfo output -------------------------------------------
 426
 427 # Grouping the document tree into Texinfo files. List of tuples
 428 # (source start file, target name, title, author,
 429 #  dir menu entry, description, category)
 430 texinfo_documents = [
 431     (master_doc, 'TheLinuxKernel', 'The Linux Kernel Documentation',
 432      author, 'TheLinuxKernel', 'One line description of project.',
 433      'Miscellaneous'),
 434 ]
 435
 436 # Documents to append as an appendix to all manuals.
 437 #texinfo_appendices = []
 438
 439 # If false, no module index is generated.
 440 #texinfo_domain_indices = True
 441
 442 # How to display URL addresses: 'footnote', 'no', or 'inline'.
 443 #texinfo_show_urls = 'footnote'
 444
 445 # If true, do not generate a @detailmenu in the "Top" node's menu.
 446 #texinfo_no_detailmenu = False
 447
 448
 449 # -- Options for Epub output ----------------------------------------------
 450
 451 # Bibliographic Dublin Core info.
 452 epub_title = project
 453 epub_author = author
 454 epub_publisher = author
 455 epub_copyright = copyright
 456
 457 # The basename for the epub file. It defaults to the project name.
 458 #epub_basename = project
 459
 460 # The HTML theme for the epub output. Since the default themes are not
 461 # optimized for small screen space, using the same theme for HTML and epub
 462 # output is usually not wise. This defaults to 'epub', a theme designed to save
 463 # visual space.
 464 #epub_theme = 'epub'
 465
 466 # The language of the text. It defaults to the language option
 467 # or 'en' if the language is not set.
 468 #epub_language = ''
 469
 470 # The scheme of the identifier. Typical schemes are ISBN or URL.
 471 #epub_scheme = ''
 472
 473 # The unique identifier of the text. This can be a ISBN number
 474 # or the project homepage.
 475 #epub_identifier = ''
 476
 477 # A unique identification for the text.
 478 #epub_uid = ''
 479
 480 # A tuple containing the cover image and cover page html template filenames.
 481 #epub_cover = ()
 482
 483 # A sequence of (type, uri, title) tuples for the guide element of content.opf.
 484 #epub_guide = ()
 485
 486 # HTML files that should be inserted before the pages created by sphinx.
 487 # The format is a list of tuples containing the path and title.
 488 #epub_pre_files = []
 489
 490 # HTML files that should be inserted after the pages created by sphinx.
 491 # The format is a list of tuples containing the path and title.
 492 #epub_post_files = []
 493
 494 # A list of files that should not be packed into the epub file.
 495 epub_exclude_files = ['search.html']
 496
 497 # The depth of the table of contents in toc.ncx.
 498 #epub_tocdepth = 3
 499
 500 # Allow duplicate toc entries.
 501 #epub_tocdup = True
 502
 503 # Choose between 'default' and 'includehidden'.
 504 #epub_tocscope = 'default'
 505
 506 # Fix unsupported image types using the Pillow.
 507 #epub_fix_images = False
 508
 509 # Scale large images.
 510 #epub_max_image_width = 0
 511
 512 # How to display URL addresses: 'footnote', 'no', or 'inline'.
 513 #epub_show_urls = 'inline'
 514
 515 # If false, no index is generated.
 516 #epub_use_index = True
 517
 518 #=======
 519 # rst2pdf
 520 #
 521 # Grouping the document tree into PDF files. List of tuples
 522 # (source start file, target name, title, author, options).
 523 #
 524 # See the Sphinx chapter of http://ralsina.me/static/manual.pdf
 525 #
 526 # FIXME: Do not add the index file here; the result will be too big. Adding
 527 # multiple PDF files here actually tries to get the cross-referencing right
 528 # *between* PDF files.
 529 pdf_documents = [
 530     ('kernel-documentation', u'Kernel', u'Kernel', u'J. Random Bozo'),
 531 ]
 532
 533 # kernel-doc extension configuration for running Sphinx directly (e.g. by Read
 534 # the Docs). In a normal build, these are supplied from the Makefile via command
 535 # line arguments.
 536 kerneldoc_bin = '../scripts/kernel-doc'
 537 kerneldoc_srctree = '..'
 538
 539 # ------------------------------------------------------------------------------
 540 # Since loadConfig overwrites settings from the global namespace, it has to be
 541 # the last statement in the conf.py file
 542 # ------------------------------------------------------------------------------
 543 loadConfig(globals())