torvalds/linux
torvalds/linux
2
0
Fork 0
mirror of git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git synced 2025-09-04 20:19:47 +08:00
Code

docs: conf.py: several coding style fixes

Browse Source 
conf.py is missing a SPDX header and doesn't really have
a proper python coding style. It also has an obsolete
commented LaTeX syntax that doesn't work anymore.

Clean it up a little bit with some help from autolints
and manual adjustments.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/063c106d96e86ca30c3266f7819f30b7247881ed.1750571906.git.mchehab+huawei@kernel.org
This commit is contained in:
Mauro Carvalho Chehab 2025-06-22 08:02:43 +02:00 committed by Jonathan Corbet
parent 9322af5e65
commit 7ea9a550f7
1 changed files with 173 additions and 180 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

353
Documentation/conf.py
View File

@ -1,24 +1,28 @@
# -*- coding: utf-8 -*- # SPDX-License-Identifier: GPL-2.0-only
# # pylint: disable=C0103,C0209
# The Linux Kernel documentation build configuration file, created by
# sphinx-quickstart on Fri Feb 12 13:51:46 2016. """
# The Linux Kernel documentation build configuration file.
# This file is execfile()d with the current directory set to its """
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
import sys
import os import os
import sphinx
import shutil import shutil
import sys
import sphinx
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
sys.path.insert(0, os.path.abspath("sphinx"))
from load_config import loadConfig # pylint: disable=C0413,E0401
# Minimal supported version
needs_sphinx = "3.4.3"
# Get Sphinx version # Get Sphinx version
major, minor, patch = sphinx.version_info[:3] major, minor, patch = sphinx.version_info[:3] # pylint: disable=I1101
# Include_patterns were added on Sphinx 5.1 # Include_patterns were added on Sphinx 5.1
if (major < 5) or (major == 5 and minor < 1): if (major < 5) or (major == 5 and minor < 1):
@ -26,23 +30,22 @@ if (major < 5) or (major == 5 and minor < 1):
else: else:
has_include_patterns = True has_include_patterns = True
# Include patterns that don't contain directory names, in glob format # Include patterns that don't contain directory names, in glob format
include_patterns = ['**.rst'] include_patterns = ["**.rst"]
# Location of Documentation/ directory # Location of Documentation/ directory
doctree = os.path.abspath('.') doctree = os.path.abspath(".")
# Exclude of patterns that don't contain directory names, in glob format. # Exclude of patterns that don't contain directory names, in glob format.
exclude_patterns = [] exclude_patterns = []
# List of patterns that contain directory names in glob format. # List of patterns that contain directory names in glob format.
dyn_include_patterns = [] dyn_include_patterns = []
dyn_exclude_patterns = ['output'] dyn_exclude_patterns = ["output"]
# Properly handle include/exclude patterns # Properly handle include/exclude patterns
# ---------------------------------------- # ----------------------------------------
def update_patterns(app, config): def update_patterns(app, config):
""" """
On Sphinx, all directories are relative to what it is passed as On Sphinx, all directories are relative to what it is passed as
SOURCEDIR parameter for sphinx-build. Due to that, all patterns SOURCEDIR parameter for sphinx-build. Due to that, all patterns
@ -53,15 +56,12 @@ def update_patterns(app, config):
exclude relative patterns that start with "../". exclude relative patterns that start with "../".
""" """
sourcedir = app.srcdir # full path to the source directory
builddir = os.environ.get("BUILDDIR")
# setup include_patterns dynamically # setup include_patterns dynamically
if has_include_patterns: if has_include_patterns:
for p in dyn_include_patterns: for p in dyn_include_patterns:
full = os.path.join(doctree, p) full = os.path.join(doctree, p)
rel_path = os.path.relpath(full, start = app.srcdir) rel_path = os.path.relpath(full, start=app.srcdir)
if rel_path.startswith("../"): if rel_path.startswith("../"):
continue continue
@ -71,15 +71,17 @@ def update_patterns(app, config):
for p in dyn_exclude_patterns: for p in dyn_exclude_patterns:
full = os.path.join(doctree, p) full = os.path.join(doctree, p)
rel_path = os.path.relpath(full, start = app.srcdir) rel_path = os.path.relpath(full, start=app.srcdir)
if rel_path.startswith("../"): if rel_path.startswith("../"):
continue continue
config.exclude_patterns.append(rel_path) config.exclude_patterns.append(rel_path)
# helper # helper
# ------ # ------
def have_command(cmd): def have_command(cmd):
"""Search ``cmd`` in the ``PATH`` environment. """Search ``cmd`` in the ``PATH`` environment.
@ -88,24 +90,23 @@ def have_command(cmd):
""" """
return shutil.which(cmd) is not None return shutil.which(cmd) is not None
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
sys.path.insert(0, os.path.abspath('sphinx'))
from load_config import loadConfig
# -- General configuration ------------------------------------------------ # -- General configuration ------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here. # Add any Sphinx extensions in alphabetic order
needs_sphinx = '3.4.3' extensions = [
"automarkup",
# Add any Sphinx extension module names here, as strings. They can be "kernel_abi",
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom "kerneldoc",
# ones. "kernel_feat",
extensions = ['kerneldoc', 'rstFlatTable', 'kernel_include', "kernel_include",
'kfigure', 'sphinx.ext.ifconfig', 'automarkup', "kfigure",
'maintainers_include', 'sphinx.ext.autosectionlabel', "maintainers_include",
'kernel_abi', 'kernel_feat', 'translations'] "rstFlatTable",
"sphinx.ext.autosectionlabel",
"sphinx.ext.ifconfig",
"translations",
]
# Since Sphinx version 3, the C function parser is more pedantic with regards # Since Sphinx version 3, the C function parser is more pedantic with regards
# to type checking. Due to that, having macros at c:function cause problems. # to type checking. Due to that, having macros at c:function cause problems.
@ -180,28 +181,28 @@ autosectionlabel_maxdepth = 2
# Load math renderer: # Load math renderer:
# For html builder, load imgmath only when its dependencies are met. # For html builder, load imgmath only when its dependencies are met.
# mathjax is the default math renderer since Sphinx 1.8. # mathjax is the default math renderer since Sphinx 1.8.
have_latex = have_command('latex') have_latex = have_command("latex")
have_dvipng = have_command('dvipng') have_dvipng = have_command("dvipng")
load_imgmath = have_latex and have_dvipng load_imgmath = have_latex and have_dvipng
# Respect SPHINX_IMGMATH (for html docs only) # Respect SPHINX_IMGMATH (for html docs only)
if 'SPHINX_IMGMATH' in os.environ: if "SPHINX_IMGMATH" in os.environ:
env_sphinx_imgmath = os.environ['SPHINX_IMGMATH'] env_sphinx_imgmath = os.environ["SPHINX_IMGMATH"]
if 'yes' in env_sphinx_imgmath: if "yes" in env_sphinx_imgmath:
load_imgmath = True load_imgmath = True
elif 'no' in env_sphinx_imgmath: elif "no" in env_sphinx_imgmath:
load_imgmath = False load_imgmath = False
else: else:
sys.stderr.write("Unknown env SPHINX_IMGMATH=%s ignored.\n" % env_sphinx_imgmath) sys.stderr.write("Unknown env SPHINX_IMGMATH=%s ignored.\n" % env_sphinx_imgmath)
if load_imgmath: if load_imgmath:
extensions.append("sphinx.ext.imgmath") extensions.append("sphinx.ext.imgmath")
math_renderer = 'imgmath' math_renderer = "imgmath"
else: else:
math_renderer = 'mathjax' math_renderer = "mathjax"
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
templates_path = ['sphinx/templates'] templates_path = ["sphinx/templates"]
# The suffix(es) of source filenames. # The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string: # You can specify multiple suffix as a list of string:
@ -209,15 +210,15 @@ templates_path = ['sphinx/templates']
source_suffix = '.rst' source_suffix = '.rst'
# The encoding of source files. # The encoding of source files.
#source_encoding = 'utf-8-sig' # source_encoding = 'utf-8-sig'
# The master toctree document. # The master toctree document.
master_doc = 'index' master_doc = "index"
# General information about the project. # General information about the project.
project = 'The Linux Kernel' project = "The Linux Kernel"
copyright = 'The kernel development community' copyright = "The kernel development community" # pylint: disable=W0622
author = 'The kernel development community' author = "The kernel development community"
# The version info for the project you're documenting, acts as replacement for # The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the # |version| and |release|, also used in various other places throughout the
@ -232,82 +233,86 @@ author = 'The kernel development community'
try: try:
makefile_version = None makefile_version = None
makefile_patchlevel = None makefile_patchlevel = None
for line in open('../Makefile'): with open("../Makefile", encoding="utf=8") as fp:
key, val = [x.strip() for x in line.split('=', 2)] for line in fp:
if key == 'VERSION': key, val = [x.strip() for x in line.split("=", 2)]
makefile_version = val if key == "VERSION":
elif key == 'PATCHLEVEL': makefile_version = val
makefile_patchlevel = val elif key == "PATCHLEVEL":
if makefile_version and makefile_patchlevel: makefile_patchlevel = val
break if makefile_version and makefile_patchlevel:
except: break
except Exception:
pass pass
finally: finally:
if makefile_version and makefile_patchlevel: if makefile_version and makefile_patchlevel:
version = release = makefile_version + '.' + makefile_patchlevel version = release = makefile_version + "." + makefile_patchlevel
else: else:
version = release = "unknown version" version = release = "unknown version"
#
# HACK: there seems to be no easy way for us to get at the version and
# release information passed in from the makefile...so go pawing through the
# command-line options and find it for ourselves.
#
def get_cline_version(): def get_cline_version():
c_version = c_release = '' """
HACK: There seems to be no easy way for us to get at the version and
release information passed in from the makefile...so go pawing through the
command-line options and find it for ourselves.
"""
c_version = c_release = ""
for arg in sys.argv: for arg in sys.argv:
if arg.startswith('version='): if arg.startswith("version="):
c_version = arg[8:] c_version = arg[8:]
elif arg.startswith('release='): elif arg.startswith("release="):
c_release = arg[8:] c_release = arg[8:]
if c_version: if c_version:
if c_release: if c_release:
return c_version + '-' + c_release return c_version + "-" + c_release
return c_version return c_version
return version # Whatever we came up with before return version # Whatever we came up with before
# The language for content autogenerated by Sphinx. Refer to documentation # The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages. # for a list of supported languages.
# #
# This is also used if you do content translation via gettext catalogs. # This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases. # Usually you set "language" from the command line for these cases.
language = 'en' language = "en"
# There are two options for replacing |today|: either, you set today to some # There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used: # non-false value, then it is used:
#today = '' # today = ''
# Else, today_fmt is used as the format for a strftime call. # Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y' # today_fmt = '%B %d, %Y'
# The reST default role (used for this markup: `text`) to use for all # The reST default role (used for this markup: `text`) to use for all
# documents. # documents.
#default_role = None # default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text. # If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True # add_function_parentheses = True
# If true, the current module name will be prepended to all description # If true, the current module name will be prepended to all description
# unit titles (such as .. function::). # unit titles (such as .. function::).
#add_module_names = True # add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the # If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default. # output. They are ignored by default.
#show_authors = False # show_authors = False
# The name of the Pygments (syntax highlighting) style to use. # The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx' pygments_style = "sphinx"
# A list of ignored prefixes for module index sorting. # A list of ignored prefixes for module index sorting.
#modindex_common_prefix = [] # modindex_common_prefix = []
# If true, keep warnings as "system message" paragraphs in the built documents. # If true, keep warnings as "system message" paragraphs in the built documents.
#keep_warnings = False # keep_warnings = False
# If true, `todo` and `todoList` produce output, else they produce nothing. # If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False todo_include_todos = False
primary_domain = 'c' primary_domain = "c"
highlight_language = 'none' highlight_language = "none"
# -- Options for HTML output ---------------------------------------------- # -- Options for HTML output ----------------------------------------------
@ -315,43 +320,45 @@ highlight_language = 'none'
# a list of builtin themes. # a list of builtin themes.
# Default theme # Default theme
html_theme = 'alabaster' html_theme = "alabaster"
html_css_files = [] html_css_files = []
if "DOCS_THEME" in os.environ: if "DOCS_THEME" in os.environ:
html_theme = os.environ["DOCS_THEME"] html_theme = os.environ["DOCS_THEME"]
if html_theme == 'sphinx_rtd_theme' or html_theme == 'sphinx_rtd_dark_mode': if html_theme in ["sphinx_rtd_theme", "sphinx_rtd_dark_mode"]:
# Read the Docs theme # Read the Docs theme
try: try:
import sphinx_rtd_theme import sphinx_rtd_theme
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
# Add any paths that contain custom static files (such as style sheets) here, # Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files, # relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css". # so a file named "default.css" will overwrite the builtin "default.css".
html_css_files = [ html_css_files = [
'theme_overrides.css', "theme_overrides.css",
] ]
# Read the Docs dark mode override theme # Read the Docs dark mode override theme
if html_theme == 'sphinx_rtd_dark_mode': if html_theme == "sphinx_rtd_dark_mode":
try: try:
import sphinx_rtd_dark_mode import sphinx_rtd_dark_mode # pylint: disable=W0611
extensions.append('sphinx_rtd_dark_mode')
except ImportError:
html_theme == 'sphinx_rtd_theme'
if html_theme == 'sphinx_rtd_theme': extensions.append("sphinx_rtd_dark_mode")
# Add color-specific RTD normal mode except ImportError:
html_css_files.append('theme_rtd_colors.css') html_theme = "sphinx_rtd_theme"
if html_theme == "sphinx_rtd_theme":
# Add color-specific RTD normal mode
html_css_files.append("theme_rtd_colors.css")
html_theme_options = { html_theme_options = {
'navigation_depth': -1, "navigation_depth": -1,
} }
except ImportError: except ImportError:
html_theme = 'alabaster' html_theme = "alabaster"
if "DOCS_CSS" in os.environ: if "DOCS_CSS" in os.environ:
css = os.environ["DOCS_CSS"].split(" ") css = os.environ["DOCS_CSS"].split(" ")
@ -359,14 +366,14 @@ if "DOCS_CSS" in os.environ:
for l in css: for l in css:
html_css_files.append(l) html_css_files.append(l)
if html_theme == 'alabaster': if html_theme == "alabaster":
html_theme_options = { html_theme_options = {
'description': get_cline_version(), "description": get_cline_version(),
'page_width': '65em', "page_width": "65em",
'sidebar_width': '15em', "sidebar_width": "15em",
'fixed_sidebar': 'true', "fixed_sidebar": "true",
'font_size': 'inherit', "font_size": "inherit",
'font_family': 'serif', "font_family": "serif",
} }
sys.stderr.write("Using %s theme\n" % html_theme) sys.stderr.write("Using %s theme\n" % html_theme)
@ -374,104 +381,79 @@ sys.stderr.write("Using %s theme\n" % html_theme)
# Add any paths that contain custom static files (such as style sheets) here, # Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files, # relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css". # so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['sphinx-static'] html_static_path = ["sphinx-static"]
# If true, Docutils "smart quotes" will be used to convert quotes and dashes # If true, Docutils "smart quotes" will be used to convert quotes and dashes
# to typographically correct entities. However, conversion of "--" to "—" # to typographically correct entities. However, conversion of "--" to "—"
# is not always what we want, so enable only quotes. # is not always what we want, so enable only quotes.
smartquotes_action = 'q' smartquotes_action = "q"
# Custom sidebar templates, maps document names to template names. # Custom sidebar templates, maps document names to template names.
# Note that the RTD theme ignores this # Note that the RTD theme ignores this
html_sidebars = { '**': ['searchbox.html', 'kernel-toc.html', 'sourcelink.html']} html_sidebars = {"**": ["searchbox.html",
"kernel-toc.html",
"sourcelink.html"]}
# about.html is available for alabaster theme. Add it at the front. # about.html is available for alabaster theme. Add it at the front.
if html_theme == 'alabaster': if html_theme == "alabaster":
html_sidebars['**'].insert(0, 'about.html') html_sidebars["**"].insert(0, "about.html")
# The name of an image file (relative to this directory) to place at the top # The name of an image file (relative to this directory) to place at the top
# of the sidebar. # of the sidebar.
html_logo = 'images/logo.svg' html_logo = "images/logo.svg"
# Output file base name for HTML help builder. # Output file base name for HTML help builder.
htmlhelp_basename = 'TheLinuxKerneldoc' htmlhelp_basename = "TheLinuxKerneldoc"
# -- Options for LaTeX output --------------------------------------------- # -- Options for LaTeX output ---------------------------------------------
latex_elements = { latex_elements = {
# The paper size ('letterpaper' or 'a4paper'). # The paper size ('letterpaper' or 'a4paper').
'papersize': 'a4paper', "papersize": "a4paper",
# The font size ('10pt', '11pt' or '12pt'). # The font size ('10pt', '11pt' or '12pt').
'pointsize': '11pt', "pointsize": "11pt",
# Latex figure (float) alignment # Latex figure (float) alignment
#'figure_align': 'htbp', # 'figure_align': 'htbp',
# Don't mangle with UTF-8 chars # Don't mangle with UTF-8 chars
'inputenc': '', "inputenc": "",
'utf8extra': '', "utf8extra": "",
# Set document margins # Set document margins
'sphinxsetup': ''' "sphinxsetup": """
hmargin=0.5in, vmargin=1in, hmargin=0.5in, vmargin=1in,
parsedliteralwraps=true, parsedliteralwraps=true,
verbatimhintsturnover=false, verbatimhintsturnover=false,
''', """,
# #
# Some of our authors are fond of deep nesting; tell latex to # Some of our authors are fond of deep nesting; tell latex to
# cope. # cope.
# #
'maxlistdepth': '10', "maxlistdepth": "10",
# For CJK One-half spacing, need to be in front of hyperref # For CJK One-half spacing, need to be in front of hyperref
'extrapackages': r'\usepackage{setspace}', "extrapackages": r"\usepackage{setspace}",
# Additional stuff for the LaTeX preamble. # Additional stuff for the LaTeX preamble.
'preamble': ''' "preamble": """
% Use some font with UTF-8 support with XeLaTeX % Use some font with UTF-8 support with XeLaTeX
\\usepackage{fontspec} \\usepackage{fontspec}
\\setsansfont{DejaVu Sans} \\setsansfont{DejaVu Sans}
\\setromanfont{DejaVu Serif} \\setromanfont{DejaVu Serif}
\\setmonofont{DejaVu Sans Mono} \\setmonofont{DejaVu Sans Mono}
''', """,
} }
# Load kerneldoc specific LaTeX settings # Load kerneldoc specific LaTeX settings
latex_elements['preamble'] += ''' latex_elements["preamble"] += """
% Load kerneldoc specific LaTeX settings % Load kerneldoc specific LaTeX settings
\\input{kerneldoc-preamble.sty} \\input{kerneldoc-preamble.sty}
''' """
# With Sphinx 1.6, it is possible to change the Bg color directly
# by using:
# \definecolor{sphinxnoteBgColor}{RGB}{204,255,255}
# \definecolor{sphinxwarningBgColor}{RGB}{255,204,204}
# \definecolor{sphinxattentionBgColor}{RGB}{255,255,204}
# \definecolor{sphinximportantBgColor}{RGB}{192,255,204}
#
# However, it require to use sphinx heavy box with:
#
# \renewenvironment{sphinxlightbox} {%
# \\begin{sphinxheavybox}
# }
# \\end{sphinxheavybox}
# }
#
# Unfortunately, the implementation is buggy: if a note is inside a
# table, it isn't displayed well. So, for now, let's use boring
# black and white notes.
# Grouping the document tree into LaTeX files. List of tuples # Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, # (source start file, target name, title,
# author, documentclass [howto, manual, or own class]). # author, documentclass [howto, manual, or own class]).
# Sorted in alphabetical order # Sorted in alphabetical order
latex_documents = [ latex_documents = []
]
# Add all other index files from Documentation/ subdirectories # Add all other index files from Documentation/ subdirectories
for fn in os.listdir('.'): for fn in os.listdir("."):
doc = os.path.join(fn, "index") doc = os.path.join(fn, "index")
if os.path.exists(doc + ".rst"): if os.path.exists(doc + ".rst"):
has = False has = False
@ -480,34 +462,39 @@ for fn in os.listdir('.'):
has = True has = True
break break
if not has: if not has:
latex_documents.append((doc, fn + '.tex', latex_documents.append(
'Linux %s Documentation' % fn.capitalize(), (
'The kernel development community', doc,
'manual')) fn + ".tex",
"Linux %s Documentation" % fn.capitalize(),
"The kernel development community",
"manual",
)
)
# The name of an image file (relative to this directory) to place at the top of # The name of an image file (relative to this directory) to place at the top of
# the title page. # the title page.
#latex_logo = None # latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts, # For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters. # not chapters.
#latex_use_parts = False # latex_use_parts = False
# If true, show page references after internal links. # If true, show page references after internal links.
#latex_show_pagerefs = False # latex_show_pagerefs = False
# If true, show URL addresses after external links. # If true, show URL addresses after external links.
#latex_show_urls = False # latex_show_urls = False
# Documents to append as an appendix to all manuals. # Documents to append as an appendix to all manuals.
#latex_appendices = [] # latex_appendices = []
# If false, no module index is generated. # If false, no module index is generated.
#latex_domain_indices = True # latex_domain_indices = True
# Additional LaTeX stuff to be copied to build directory # Additional LaTeX stuff to be copied to build directory
latex_additional_files = [ latex_additional_files = [
'sphinx/kerneldoc-preamble.sty', "sphinx/kerneldoc-preamble.sty",
] ]
@ -516,12 +503,11 @@ latex_additional_files = [
# One entry per manual page. List of tuples # One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section). # (source start file, name, description, authors, manual section).
man_pages = [ man_pages = [
(master_doc, 'thelinuxkernel', 'The Linux Kernel Documentation', (master_doc, "thelinuxkernel", "The Linux Kernel Documentation", [author], 1)
[author], 1)
] ]
# If true, show URL addresses after external links. # If true, show URL addresses after external links.
#man_show_urls = False # man_show_urls = False
# -- Options for Texinfo output ------------------------------------------- # -- Options for Texinfo output -------------------------------------------
@ -529,11 +515,15 @@ man_pages = [
# Grouping the document tree into Texinfo files. List of tuples # Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author, # (source start file, target name, title, author,
# dir menu entry, description, category) # dir menu entry, description, category)
texinfo_documents = [ texinfo_documents = [(
(master_doc, 'TheLinuxKernel', 'The Linux Kernel Documentation', master_doc,
author, 'TheLinuxKernel', 'One line description of project.', "TheLinuxKernel",
'Miscellaneous'), "The Linux Kernel Documentation",
] author,
"TheLinuxKernel",
"One line description of project.",
"Miscellaneous",
),]
# -- Options for Epub output ---------------------------------------------- # -- Options for Epub output ----------------------------------------------
@ -544,9 +534,9 @@ epub_publisher = author
epub_copyright = copyright epub_copyright = copyright
# A list of files that should not be packed into the epub file. # A list of files that should not be packed into the epub file.
epub_exclude_files = ['search.html'] epub_exclude_files = ["search.html"]
#======= # =======
# rst2pdf # rst2pdf
# #
# Grouping the document tree into PDF files. List of tuples # Grouping the document tree into PDF files. List of tuples
@ -558,14 +548,14 @@ epub_exclude_files = ['search.html']
# multiple PDF files here actually tries to get the cross-referencing right # multiple PDF files here actually tries to get the cross-referencing right
# *between* PDF files. # *between* PDF files.
pdf_documents = [ pdf_documents = [
('kernel-documentation', u'Kernel', u'Kernel', u'J. Random Bozo'), ("kernel-documentation", "Kernel", "Kernel", "J. Random Bozo"),
] ]
# kernel-doc extension configuration for running Sphinx directly (e.g. by Read # kernel-doc extension configuration for running Sphinx directly (e.g. by Read
# the Docs). In a normal build, these are supplied from the Makefile via command # the Docs). In a normal build, these are supplied from the Makefile via command
# line arguments. # line arguments.
kerneldoc_bin = '../scripts/kernel-doc.py' kerneldoc_bin = "../scripts/kernel-doc.py"
kerneldoc_srctree = '..' kerneldoc_srctree = ".."
# ------------------------------------------------------------------------------ # ------------------------------------------------------------------------------
# Since loadConfig overwrites settings from the global namespace, it has to be # Since loadConfig overwrites settings from the global namespace, it has to be
@ -573,5 +563,8 @@ kerneldoc_srctree = '..'
# ------------------------------------------------------------------------------ # ------------------------------------------------------------------------------
loadConfig(globals()) loadConfig(globals())
def setup(app): def setup(app):
"""Patterns need to be updated at init time on older Sphinx versions"""
app.connect('config-inited', update_patterns) app.connect('config-inited', update_patterns)