linux/Documentation/conf.py

1 # -*- coding: utf-8 -*-
4 # sphinx-quickstart on Fri Feb 12 13:51:46 2016.
7 # containing dir.
21 # ------
23 def have_command(cmd):  argument
24     """Search ``cmd`` in the ``PATH`` environment.
29     return shutil.which(cmd) is not None
47 # -- General configuration ------------------------------------------------
168 #source_encoding = 'utf-8-sig'
210 # command-line options and find it for ourselves.
221             return c_version + '-' + c_release
233 # non-false value, then it is used:
246 # If true, '()' will be appended to :func: etc. cross-reference text.
272 # -- Options for HTML output ----------------------------------------------
306                 # Add color-specific RTD normal mode
310             'navigation_depth': -1,
345 html_static_path = ['sphinx-static']
348 # to typographically correct entities.  However, conversion of "--" to "—"
354 html_sidebars = { '**': ['searchbox.html', 'kernel-toc.html', 'sourcelink.html']}
363 # -- Options for LaTeX output ---------------------------------------------
375     # Don't mangle with UTF-8 chars
392     # For CJK One-half spacing, need to be in front of hyperref
397         % Use some font with UTF-8 support with XeLaTeX
413 	\\input{kerneldoc-preamble.sty}
479     'sphinx/kerneldoc-preamble.sty',
483 # -- Options for manual page output ---------------------------------------
496 # -- Options for Texinfo output -------------------------------------------
500 #  dir menu entry, description, category)
507 # -- Options for Epub output ----------------------------------------------
527 # multiple PDF files here actually tries to get the cross-referencing right
530     ('kernel-documentation', u'Kernel', u'Kernel', u'J. Random Bozo'),
533 # kernel-doc extension configuration for running Sphinx directly (e.g. by Read
536 kerneldoc_bin = '../scripts/kernel-doc'
539 # ------------------------------------------------------------------------------
542 # ------------------------------------------------------------------------------