[thirdparty/kernel/linux.git] / Documentation / conf.py

# -*- coding: utf-8 -*-
#
# The Linux Kernel documentation build configuration file, created by
# sphinx-quickstart on Fri Feb 12 13:51:46 2016.
#
# 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 sphinx
import shutil

# helper
# ------

def have_command(cmd):
    """Search ``cmd`` in the ``PATH`` environment.

    If found, return True.
    If not found, return False.
    """
    return shutil.which(cmd) is not None

# Get Sphinx version
major, minor, patch = sphinx.version_info[:3]

#
# Warn about older versions that we don't want to support for much
# longer.
#
if (major < 2) or (major == 2 and minor < 4):
    print('WARNING: support for Sphinx < 2.4 will be removed soon.')

# 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 ------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
needs_sphinx = '2.4.4'

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = ['kerneldoc', 'rstFlatTable', 'kernel_include',
              'kfigure', 'sphinx.ext.ifconfig', 'automarkup',
              'maintainers_include', 'sphinx.ext.autosectionlabel',
              'kernel_abi', 'kernel_feat', 'translations']

if major >= 3:
    if (major > 3) or (minor > 0 or patch >= 2):
        # Sphinx c function parser is more pedantic with regards to type
        # checking. Due to that, having macros at c:function cause problems.
        # Those needed to be scaped by using c_id_attributes[] array
        c_id_attributes = [
            # GCC Compiler types not parsed by Sphinx:
            "__restrict__",

            # include/linux/compiler_types.h:
            "__iomem",
            "__kernel",
            "noinstr",
            "notrace",
            "__percpu",
            "__rcu",
            "__user",
            "__force",

            # include/linux/compiler_attributes.h:
            "__alias",
            "__aligned",
            "__aligned_largest",
            "__always_inline",
            "__assume_aligned",
            "__cold",
            "__attribute_const__",
            "__copy",
            "__pure",
            "__designated_init",
            "__visible",
            "__printf",
            "__scanf",
            "__gnu_inline",
            "__malloc",
            "__mode",
            "__no_caller_saved_registers",
            "__noclone",
            "__nonstring",
            "__noreturn",
            "__packed",
            "__pure",
            "__section",
            "__always_unused",
            "__maybe_unused",
            "__used",
            "__weak",
            "noinline",
            "__fix_address",
            "__counted_by",

            # include/linux/memblock.h:
            "__init_memblock",
            "__meminit",

            # include/linux/init.h:
            "__init",
            "__ref",

            # include/linux/linkage.h:
            "asmlinkage",

            # include/linux/btf.h
            "__bpf_kfunc",
        ]

else:
    extensions.append('cdomain')

# Ensure that autosectionlabel will produce unique names
autosectionlabel_prefix_document = True
autosectionlabel_maxdepth = 2

# Load math renderer:
# For html builder, load imgmath only when its dependencies are met.
# mathjax is the default math renderer since Sphinx 1.8.
have_latex =  have_command('latex')
have_dvipng = have_command('dvipng')
load_imgmath = have_latex and have_dvipng

# Respect SPHINX_IMGMATH (for html docs only)
if 'SPHINX_IMGMATH' in os.environ:
    env_sphinx_imgmath = os.environ['SPHINX_IMGMATH']
    if 'yes' in env_sphinx_imgmath:
        load_imgmath = True
    elif 'no' in env_sphinx_imgmath:
        load_imgmath = False
    else:
        sys.stderr.write("Unknown env SPHINX_IMGMATH=%s ignored.\n" % env_sphinx_imgmath)

# Always load imgmath for Sphinx <1.8 or for epub docs
load_imgmath = (load_imgmath or (major == 1 and minor < 8)
                or 'epub' in sys.argv)

if load_imgmath:
    extensions.append("sphinx.ext.imgmath")
    math_renderer = 'imgmath'
else:
    math_renderer = 'mathjax'

# Add any paths that contain templates here, relative to this directory.
templates_path = ['sphinx/templates']

# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
# source_suffix = ['.rst', '.md']
source_suffix = '.rst'

# The encoding of source files.
#source_encoding = 'utf-8-sig'

# The master toctree document.
master_doc = 'index'

# General information about the project.
project = 'The Linux Kernel'
copyright = 'The kernel development community'
author = 'The kernel development community'

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# In a normal build, version and release are are set to KERNELVERSION and
# KERNELRELEASE, respectively, from the Makefile via Sphinx command line
# arguments.
#
# The following code tries to extract the information by reading the Makefile,
# when Sphinx is run directly (e.g. by Read the Docs).
try:
    makefile_version = None
    makefile_patchlevel = None
    for line in open('../Makefile'):
        key, val = [x.strip() for x in line.split('=', 2)]
        if key == 'VERSION':
            makefile_version = val
        elif key == 'PATCHLEVEL':
            makefile_patchlevel = val
        if makefile_version and makefile_patchlevel:
            break
except:
    pass
finally:
    if makefile_version and makefile_patchlevel:
        version = release = makefile_version + '.' + makefile_patchlevel
    else:
        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():
    c_version = c_release = ''
    for arg in sys.argv:
        if arg.startswith('version='):
            c_version = arg[8:]
        elif arg.startswith('release='):
            c_release = arg[8:]
    if c_version:
        if c_release:
            return c_version + '-' + c_release
        return c_version
    return version # Whatever we came up with before

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = 'en'

# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['output']

# The reST default role (used for this markup: `text`) to use for all
# documents.
#default_role = None

# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True

# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True

# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'

# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []

# If true, keep warnings as "system message" paragraphs in the built documents.
#keep_warnings = False

# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False

primary_domain = 'c'
highlight_language = 'none'

# -- Options for HTML output ----------------------------------------------

# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.

# Default theme
html_theme = 'alabaster'
html_css_files = []

if "DOCS_THEME" in os.environ:
    html_theme = os.environ["DOCS_THEME"]

if html_theme == 'sphinx_rtd_theme' or html_theme == 'sphinx_rtd_dark_mode':
    # Read the Docs theme
    try:
        import sphinx_rtd_theme
        html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

        # 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,
        # so a file named "default.css" will overwrite the builtin "default.css".
        html_css_files = [
            'theme_overrides.css',
        ]

        # Read the Docs dark mode override theme
        if html_theme == 'sphinx_rtd_dark_mode':
            try:
                import sphinx_rtd_dark_mode
                extensions.append('sphinx_rtd_dark_mode')
            except ImportError:
                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 = {
            'navigation_depth': -1,
        }

    except ImportError:
        html_theme = 'alabaster'

if "DOCS_CSS" in os.environ:
    css = os.environ["DOCS_CSS"].split(" ")

    for l in css:
        html_css_files.append(l)

if major <= 1 and minor < 8:
    html_context = {
        'css_files': [],
    }

    for l in html_css_files:
        html_context['css_files'].append('_static/' + l)

if  html_theme == 'alabaster':
    html_theme_options = {
        'description': get_cline_version(),
        'page_width': '65em',
        'sidebar_width': '15em',
        'fixed_sidebar': 'true',
        'font_size': 'inherit',
        'font_family': 'serif',
    }

sys.stderr.write("Using %s theme\n" % html_theme)

# 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,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['sphinx-static']

# If true, Docutils "smart quotes" will be used to convert quotes and dashes
# to typographically correct entities.  However, conversion of "--" to "—"
# is not always what we want, so enable only quotes.
smartquotes_action = 'q'

# Custom sidebar templates, maps document names to template names.
# Note that the RTD theme ignores this
html_sidebars = { '**': ['searchbox.html', 'kernel-toc.html', 'sourcelink.html']}

# about.html is available for alabaster theme. Add it at the front.
if html_theme == 'alabaster':
    html_sidebars['**'].insert(0, 'about.html')

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
html_logo = 'images/logo.svg'

# Output file base name for HTML help builder.
htmlhelp_basename = 'TheLinuxKerneldoc'

# -- Options for LaTeX output ---------------------------------------------

latex_elements = {
    # The paper size ('letterpaper' or 'a4paper').
    'papersize': 'a4paper',

    # The font size ('10pt', '11pt' or '12pt').
    'pointsize': '11pt',

    # Latex figure (float) alignment
    #'figure_align': 'htbp',

    # Don't mangle with UTF-8 chars
    'inputenc': '',
    'utf8extra': '',

    # Set document margins
    'sphinxsetup': '''
        hmargin=0.5in, vmargin=1in,
        parsedliteralwraps=true,
        verbatimhintsturnover=false,
    ''',

    #
    # Some of our authors are fond of deep nesting; tell latex to
    # cope.
    #
    'maxlistdepth': '10',

    # For CJK One-half spacing, need to be in front of hyperref
    'extrapackages': r'\usepackage{setspace}',

    # Additional stuff for the LaTeX preamble.
    'preamble': '''
        % Use some font with UTF-8 support with XeLaTeX
        \\usepackage{fontspec}
        \\setsansfont{DejaVu Sans}
        \\setromanfont{DejaVu Serif}
        \\setmonofont{DejaVu Sans Mono}
    ''',
}

# Fix reference escape troubles with Sphinx 1.4.x
if major == 1:
    latex_elements['preamble']  += '\\renewcommand*{\\DUrole}[2]{ #2 }\n'


# Load kerneldoc specific LaTeX settings
latex_elements['preamble'] += '''
        % Load kerneldoc specific LaTeX settings
	\\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
# (source start file, target name, title,
#  author, documentclass [howto, manual, or own class]).
# Sorted in alphabetical order
latex_documents = [
]

# Add all other index files from Documentation/ subdirectories
for fn in os.listdir('.'):
    doc = os.path.join(fn, "index")
    if os.path.exists(doc + ".rst"):
        has = False
        for l in latex_documents:
            if l[0] == doc:
                has = True
                break
        if not has:
            latex_documents.append((doc, 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 title page.
#latex_logo = None

# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False

# If true, show page references after internal links.
#latex_show_pagerefs = False

# If true, show URL addresses after external links.
#latex_show_urls = False

# Documents to append as an appendix to all manuals.
#latex_appendices = []

# If false, no module index is generated.
#latex_domain_indices = True

# Additional LaTeX stuff to be copied to build directory
latex_additional_files = [
    'sphinx/kerneldoc-preamble.sty',
]


# -- Options for manual page output ---------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
    (master_doc, 'thelinuxkernel', 'The Linux Kernel Documentation',
     [author], 1)
]

# If true, show URL addresses after external links.
#man_show_urls = False


# -- Options for Texinfo output -------------------------------------------

# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
#  dir menu entry, description, category)
texinfo_documents = [
    (master_doc, 'TheLinuxKernel', 'The Linux Kernel Documentation',
     author, 'TheLinuxKernel', 'One line description of project.',
     'Miscellaneous'),
]

# -- Options for Epub output ----------------------------------------------

# Bibliographic Dublin Core info.
epub_title = project
epub_author = author
epub_publisher = author
epub_copyright = copyright

# A list of files that should not be packed into the epub file.
epub_exclude_files = ['search.html']

#=======
# rst2pdf
#
# Grouping the document tree into PDF files. List of tuples
# (source start file, target name, title, author, options).
#
# See the Sphinx chapter of https://ralsina.me/static/manual.pdf
#
# FIXME: Do not add the index file here; the result will be too big. Adding
# multiple PDF files here actually tries to get the cross-referencing right
# *between* PDF files.
pdf_documents = [
    ('kernel-documentation', u'Kernel', u'Kernel', u'J. Random Bozo'),
]

# 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
# line arguments.
kerneldoc_bin = '../scripts/kernel-doc'
kerneldoc_srctree = '..'

# ------------------------------------------------------------------------------
# Since loadConfig overwrites settings from the global namespace, it has to be
# the last statement in the conf.py file
# ------------------------------------------------------------------------------
loadConfig(globals())
Commit	Line	Data
22cba31b JN	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
d4fe7e14	17	import sphinx
6b0d3e7c AY	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
d4fe7e14 MCC	30
d4fe7e14 MCC	31	# Get Sphinx version
c46988ae	32	major, minor, patch = sphinx.version_info[:3]
d4fe7e14	33
31abfdda JC	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.')
22cba31b JN	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.
24dcdeb2	44	sys.path.insert(0, os.path.abspath('sphinx'))
606b9ac8	45	from load_config import loadConfig
22cba31b JN	46
	47	# -- General configuration ------------------------------------------------
	48
	49	# If your documentation needs a minimal Sphinx version, state it here.
3e893e16	50	needs_sphinx = '2.4.4'
22cba31b JN	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.
afde706a	55	extensions = ['kerneldoc', 'rstFlatTable', 'kernel_include',
aa204855	56	'kfigure', 'sphinx.ext.ifconfig', 'automarkup',
a7ee04b3	57	'maintainers_include', 'sphinx.ext.autosectionlabel',
7418ec5b	58	'kernel_abi', 'kernel_feat', 'translations']
22cba31b	59
afde706a	60	if major >= 3:
d29f34c0	61	if (major > 3) or (minor > 0 or patch >= 2):
b34b86d7 MCC	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",
34d9f62e	77	"__force",
b34b86d7 MCC	78
	79	# include/linux/compiler_attributes.h:
	80	"__alias",
	81	"__aligned",
	82	"__aligned_largest",
	83	"__always_inline",
	84	"__assume_aligned",
	85	"__cold",
	86	"__attribute_const__",
	87	"__copy",
	88	"__pure",
	89	"__designated_init",
	90	"__visible",
	91	"__printf",
	92	"__scanf",
	93	"__gnu_inline",
	94	"__malloc",
	95	"__mode",
	96	"__no_caller_saved_registers",
	97	"__noclone",
	98	"__nonstring",
	99	"__noreturn",
	100	"__packed",
	101	"__pure",
	102	"__section",
	103	"__always_unused",
	104	"__maybe_unused",
	105	"__used",
	106	"__weak",
	107	"noinline",
5479d6d4	108	"__fix_address",
eeddfa5b	109	"__counted_by",
b34b86d7 MCC	110
	111	# include/linux/memblock.h:
	112	"__init_memblock",
	113	"__meminit",
	114
	115	# include/linux/init.h:
	116	"__init",
	117	"__ref",
	118
	119	# include/linux/linkage.h:
	120	"asmlinkage",
98e6ab7a DV	121
	122	# include/linux/btf.h
	123	"__bpf_kfunc",
b34b86d7 MCC	124	]
b34b86d7 MCC	125
afde706a JC	126	else:
	127	extensions.append('cdomain')
	128
4658b0eb MCC	129	# Ensure that autosectionlabel will produce unique names
	130	autosectionlabel_prefix_document = True
	131	autosectionlabel_maxdepth = 2
	132
6b0d3e7c AY	133	# Load math renderer:
	134	# For html builder, load imgmath only when its dependencies are met.
	135	# mathjax is the default math renderer since Sphinx 1.8.
	136	have_latex = have_command('latex')
	137	have_dvipng = have_command('dvipng')
3b384e95 AY	138	load_imgmath = have_latex and have_dvipng
	139
	140	# Respect SPHINX_IMGMATH (for html docs only)
	141	if 'SPHINX_IMGMATH' in os.environ:
	142	env_sphinx_imgmath = os.environ['SPHINX_IMGMATH']
	143	if 'yes' in env_sphinx_imgmath:
	144	load_imgmath = True
	145	elif 'no' in env_sphinx_imgmath:
	146	load_imgmath = False
	147	else:
	148	sys.stderr.write("Unknown env SPHINX_IMGMATH=%s ignored.\n" % env_sphinx_imgmath)
	149
	150	# Always load imgmath for Sphinx <1.8 or for epub docs
	151	load_imgmath = (load_imgmath or (major == 1 and minor < 8)
6b0d3e7c AY	152	or 'epub' in sys.argv)
	153
	154	if load_imgmath:
	155	extensions.append("sphinx.ext.imgmath")
	156	math_renderer = 'imgmath'
	157	else:
	158	math_renderer = 'mathjax'
22cba31b JN	159
22cba31b JN	160	# Add any paths that contain templates here, relative to this directory.
c404f5d4	161	templates_path = ['sphinx/templates']
22cba31b JN	162
	163	# The suffix(es) of source filenames.
	164	# You can specify multiple suffix as a list of string:
	165	# source_suffix = ['.rst', '.md']
	166	source_suffix = '.rst'
	167
	168	# The encoding of source files.
	169	#source_encoding = 'utf-8-sig'
	170
	171	# The master toctree document.
	172	master_doc = 'index'
	173
	174	# General information about the project.
	175	project = 'The Linux Kernel'
dc36143f	176	copyright = 'The kernel development community'
22cba31b JN	177	author = 'The kernel development community'
	178
	179	# The version info for the project you're documenting, acts as replacement for
	180	# \|version\| and \|release\|, also used in various other places throughout the
	181	# built documents.
	182	#
c13ce448 JN	183	# In a normal build, version and release are are set to KERNELVERSION and
	184	# KERNELRELEASE, respectively, from the Makefile via Sphinx command line
	185	# arguments.
	186	#
	187	# The following code tries to extract the information by reading the Makefile,
	188	# when Sphinx is run directly (e.g. by Read the Docs).
	189	try:
	190	makefile_version = None
	191	makefile_patchlevel = None
	192	for line in open('../Makefile'):
	193	key, val = [x.strip() for x in line.split('=', 2)]
	194	if key == 'VERSION':
	195	makefile_version = val
	196	elif key == 'PATCHLEVEL':
	197	makefile_patchlevel = val
	198	if makefile_version and makefile_patchlevel:
	199	break
	200	except:
	201	pass
	202	finally:
	203	if makefile_version and makefile_patchlevel:
	204	version = release = makefile_version + '.' + makefile_patchlevel
	205	else:
c13ce448	206	version = release = "unknown version"
22cba31b	207
d5389d31 JC	208	#
	209	# HACK: there seems to be no easy way for us to get at the version and
	210	# release information passed in from the makefile...so go pawing through the
	211	# command-line options and find it for ourselves.
	212	#
	213	def get_cline_version():
	214	c_version = c_release = ''
	215	for arg in sys.argv:
	216	if arg.startswith('version='):
	217	c_version = arg[8:]
	218	elif arg.startswith('release='):
	219	c_release = arg[8:]
	220	if c_version:
	221	if c_release:
	222	return c_version + '-' + c_release
	223	return c_version
	224	return version # Whatever we came up with before
	225
22cba31b JN	226	# The language for content autogenerated by Sphinx. Refer to documentation
	227	# for a list of supported languages.
	228	#
	229	# This is also used if you do content translation via gettext catalogs.
	230	# Usually you set "language" from the command line for these cases.
627f01ea	231	language = 'en'
22cba31b JN	232
	233	# There are two options for replacing \|today\|: either, you set today to some
	234	# non-false value, then it is used:
	235	#today = ''
	236	# Else, today_fmt is used as the format for a strftime call.
	237	#today_fmt = '%B %d, %Y'
	238
	239	# List of patterns, relative to source directory, that match files and
	240	# directories to ignore when looking for source files.
	241	exclude_patterns = ['output']
	242
	243	# The reST default role (used for this markup: `text`) to use for all
	244	# documents.
	245	#default_role = None
	246
	247	# If true, '()' will be appended to :func: etc. cross-reference text.
	248	#add_function_parentheses = True
	249
	250	# If true, the current module name will be prepended to all description
	251	# unit titles (such as .. function::).
	252	#add_module_names = True
	253
	254	# If true, sectionauthor and moduleauthor directives will be shown in the
	255	# output. They are ignored by default.
	256	#show_authors = False
	257
	258	# The name of the Pygments (syntax highlighting) style to use.
	259	pygments_style = 'sphinx'
	260
	261	# A list of ignored prefixes for module index sorting.
	262	#modindex_common_prefix = []
	263
	264	# If true, keep warnings as "system message" paragraphs in the built documents.
	265	#keep_warnings = False
	266
	267	# If true, `todo` and `todoList` produce output, else they produce nothing.
	268	todo_include_todos = False
	269
fd5d6669	270	primary_domain = 'c'
b459106e	271	highlight_language = 'none'
22cba31b JN	272
	273	# -- Options for HTML output ----------------------------------------------
	274
	275	# The theme to use for HTML and HTML Help pages. See the documentation for
	276	# a list of builtin themes.
	277
fca7216b	278	# Default theme
d5389d31	279	html_theme = 'alabaster'
135707d3	280	html_css_files = []
fca7216b MCC	281
	282	if "DOCS_THEME" in os.environ:
	283	html_theme = os.environ["DOCS_THEME"]
	284
a6fb8b5a	285	if html_theme == 'sphinx_rtd_theme' or html_theme == 'sphinx_rtd_dark_mode':
fca7216b MCC	286	# Read the Docs theme
	287	try:
	288	import sphinx_rtd_theme
	289	html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
	290
	291	# Add any paths that contain custom static files (such as style sheets) here,
	292	# relative to this directory. They are copied after the builtin static files,
	293	# so a file named "default.css" will overwrite the builtin "default.css".
	294	html_css_files = [
	295	'theme_overrides.css',
	296	]
a6fb8b5a MCC	297
	298	# Read the Docs dark mode override theme
	299	if html_theme == 'sphinx_rtd_dark_mode':
	300	try:
	301	import sphinx_rtd_dark_mode
	302	extensions.append('sphinx_rtd_dark_mode')
	303	except ImportError:
	304	html_theme == 'sphinx_rtd_theme'
	305
	306	if html_theme == 'sphinx_rtd_theme':
	307	# Add color-specific RTD normal mode
	308	html_css_files.append('theme_rtd_colors.css')
	309
e17f2260 DV	310	html_theme_options = {
	311	'navigation_depth': -1,
	312	}
	313
fca7216b	314	except ImportError:
02d33e86	315	html_theme = 'alabaster'
fca7216b	316
135707d3 MCC	317	if "DOCS_CSS" in os.environ:
	318	css = os.environ["DOCS_CSS"].split(" ")
	319
	320	for l in css:
	321	html_css_files.append(l)
	322
fca7216b MCC	323	if major <= 1 and minor < 8:
	324	html_context = {
	325	'css_files': [],
	326	}
	327
	328	for l in html_css_files:
	329	html_context['css_files'].append('_static/' + l)
	330
02d33e86	331	if html_theme == 'alabaster':
d5389d31 JC	332	html_theme_options = {
d5389d31 JC	333	'description': get_cline_version(),
2056b920 JC	334	'page_width': '65em',
2056b920 JC	335	'sidebar_width': '15em',
c404f5d4	336	'fixed_sidebar': 'true',
bd5d1cc8 JC	337	'font_size': 'inherit',
bd5d1cc8 JC	338	'font_family': 'serif',
d5389d31	339	}
ffc901b4	340
fca7216b	341	sys.stderr.write("Using %s theme\n" % html_theme)
22cba31b	342
22cba31b JN	343	# Add any paths that contain custom static files (such as style sheets) here,
	344	# relative to this directory. They are copied after the builtin static files,
	345	# so a file named "default.css" will overwrite the builtin "default.css".
bc214671 MH	346	html_static_path = ['sphinx-static']
bc214671 MH	347
eaae7575	348	# If true, Docutils "smart quotes" will be used to convert quotes and dashes
fe256258 AY	349	# to typographically correct entities. However, conversion of "--" to "—"
	350	# is not always what we want, so enable only quotes.
	351	smartquotes_action = 'q'
22cba31b JN	352
22cba31b JN	353	# Custom sidebar templates, maps document names to template names.
d5389d31	354	# Note that the RTD theme ignores this
c404f5d4	355	html_sidebars = { '**': ['searchbox.html', 'kernel-toc.html', 'sourcelink.html']}
a33ae832 AY	356
	357	# about.html is available for alabaster theme. Add it at the front.
	358	if html_theme == 'alabaster':
	359	html_sidebars['**'].insert(0, 'about.html')
22cba31b	360
d49af114 VN	361	# The name of an image file (relative to this directory) to place at the top
	362	# of the sidebar.
	363	html_logo = 'images/logo.svg'
	364
22cba31b JN	365	# Output file base name for HTML help builder.
	366	htmlhelp_basename = 'TheLinuxKerneldoc'
	367
	368	# -- Options for LaTeX output ---------------------------------------------
	369
	370	latex_elements = {
3b4c9632 MCC	371	# The paper size ('letterpaper' or 'a4paper').
3b4c9632 MCC	372	'papersize': 'a4paper',
22cba31b	373
3b4c9632 MCC	374	# The font size ('10pt', '11pt' or '12pt').
3b4c9632 MCC	375	'pointsize': '11pt',
22cba31b	376
3b4c9632 MCC	377	# Latex figure (float) alignment
3b4c9632 MCC	378	#'figure_align': 'htbp',
caee5cde	379
3b4c9632 MCC	380	# Don't mangle with UTF-8 chars
	381	'inputenc': '',
	382	'utf8extra': '',
a682ec4b	383
3b4c9632 MCC	384	# Set document margins
	385	'sphinxsetup': '''
	386	hmargin=0.5in, vmargin=1in,
	387	parsedliteralwraps=true,
	388	verbatimhintsturnover=false,
	389	''',
	390
0df8669f JC	391	#
	392	# Some of our authors are fond of deep nesting; tell latex to
	393	# cope.
	394	#
	395	'maxlistdepth': '10',
	396
77abc2c2 AY	397	# For CJK One-half spacing, need to be in front of hyperref
	398	'extrapackages': r'\usepackage{setspace}',
	399
3b4c9632	400	# Additional stuff for the LaTeX preamble.
caee5cde	401	'preamble': '''
3b4c9632	402	% Use some font with UTF-8 support with XeLaTeX
9fdcd6af	403	\\usepackage{fontspec}
44ba0bb4 DW	404	\\setsansfont{DejaVu Sans}
44ba0bb4 DW	405	\\setromanfont{DejaVu Serif}
9fdcd6af	406	\\setmonofont{DejaVu Sans Mono}
398f7abd	407	''',
e0de2b59	408	}
9fdcd6af	409
9fdcd6af	410	# Fix reference escape troubles with Sphinx 1.4.x
f546ff0c	411	if major == 1:
9fdcd6af MCC	412	latex_elements['preamble'] += '\\renewcommand*{\\DUrole}[2]{ #2 }\n'
9fdcd6af MCC	413
398f7abd AY	414
	415	# Load kerneldoc specific LaTeX settings
	416	latex_elements['preamble'] += '''
	417	% Load kerneldoc specific LaTeX settings
	418	\\input{kerneldoc-preamble.sty}
	419	'''
	420
9fdcd6af MCC	421	# With Sphinx 1.6, it is possible to change the Bg color directly
	422	# by using:
	423	# \definecolor{sphinxnoteBgColor}{RGB}{204,255,255}
	424	# \definecolor{sphinxwarningBgColor}{RGB}{255,204,204}
	425	# \definecolor{sphinxattentionBgColor}{RGB}{255,255,204}
	426	# \definecolor{sphinximportantBgColor}{RGB}{192,255,204}
	427	#
	428	# However, it require to use sphinx heavy box with:
	429	#
	430	# \renewenvironment{sphinxlightbox} {%
	431	# \\begin{sphinxheavybox}
	432	# }
	433	# \\end{sphinxheavybox}
	434	# }
	435	#
	436	# Unfortunately, the implementation is buggy: if a note is inside a
	437	# table, it isn't displayed well. So, for now, let's use boring
	438	# black and white notes.
633d612b	439
22cba31b JN	440	# Grouping the document tree into LaTeX files. List of tuples
	441	# (source start file, target name, title,
	442	# author, documentclass [howto, manual, or own class]).
c2b563d8	443	# Sorted in alphabetical order
22cba31b	444	latex_documents = [
22cba31b JN	445	]
22cba31b JN	446
9d42afbe MCC	447	# Add all other index files from Documentation/ subdirectories
	448	for fn in os.listdir('.'):
	449	doc = os.path.join(fn, "index")
	450	if os.path.exists(doc + ".rst"):
	451	has = False
	452	for l in latex_documents:
	453	if l[0] == doc:
	454	has = True
	455	break
	456	if not has:
	457	latex_documents.append((doc, fn + '.tex',
	458	'Linux %s Documentation' % fn.capitalize(),
	459	'The kernel development community',
	460	'manual'))
	461
22cba31b JN	462	# The name of an image file (relative to this directory) to place at the top of
	463	# the title page.
	464	#latex_logo = None
	465
	466	# For "manual" documents, if this is true, then toplevel headings are parts,
	467	# not chapters.
	468	#latex_use_parts = False
	469
	470	# If true, show page references after internal links.
	471	#latex_show_pagerefs = False
	472
	473	# If true, show URL addresses after external links.
	474	#latex_show_urls = False
	475
	476	# Documents to append as an appendix to all manuals.
	477	#latex_appendices = []
	478
	479	# If false, no module index is generated.
	480	#latex_domain_indices = True
	481
398f7abd AY	482	# Additional LaTeX stuff to be copied to build directory
	483	latex_additional_files = [
	484	'sphinx/kerneldoc-preamble.sty',
	485	]
	486
22cba31b JN	487
	488	# -- Options for manual page output ---------------------------------------
	489
	490	# One entry per manual page. List of tuples
	491	# (source start file, name, description, authors, manual section).
	492	man_pages = [
	493	(master_doc, 'thelinuxkernel', 'The Linux Kernel Documentation',
	494	[author], 1)
	495	]
	496
	497	# If true, show URL addresses after external links.
	498	#man_show_urls = False
	499
	500
	501	# -- Options for Texinfo output -------------------------------------------
	502
	503	# Grouping the document tree into Texinfo files. List of tuples
	504	# (source start file, target name, title, author,
	505	# dir menu entry, description, category)
	506	texinfo_documents = [
	507	(master_doc, 'TheLinuxKernel', 'The Linux Kernel Documentation',
	508	author, 'TheLinuxKernel', 'One line description of project.',
	509	'Miscellaneous'),
	510	]
	511
22cba31b JN	512	# -- Options for Epub output ----------------------------------------------
	513
	514	# Bibliographic Dublin Core info.
	515	epub_title = project
	516	epub_author = author
	517	epub_publisher = author
	518	epub_copyright = copyright
	519
22cba31b JN	520	# A list of files that should not be packed into the epub file.
	521	epub_exclude_files = ['search.html']
	522
22cba31b JN	523	#=======
	524	# rst2pdf
	525	#
	526	# Grouping the document tree into PDF files. List of tuples
	527	# (source start file, target name, title, author, options).
	528	#
93431e06	529	# See the Sphinx chapter of https://ralsina.me/static/manual.pdf
22cba31b JN	530	#
	531	# FIXME: Do not add the index file here; the result will be too big. Adding
	532	# multiple PDF files here actually tries to get the cross-referencing right
	533	# between PDF files.
	534	pdf_documents = [
520a2477	535	('kernel-documentation', u'Kernel', u'Kernel', u'J. Random Bozo'),
22cba31b	536	]
24dcdeb2 JN	537
	538	# kernel-doc extension configuration for running Sphinx directly (e.g. by Read
	539	# the Docs). In a normal build, these are supplied from the Makefile via command
	540	# line arguments.
	541	kerneldoc_bin = '../scripts/kernel-doc'
	542	kerneldoc_srctree = '..'
606b9ac8 MH	543
	544	# ------------------------------------------------------------------------------
	545	# Since loadConfig overwrites settings from the global namespace, it has to be
	546	# the last statement in the conf.py file
	547	# ------------------------------------------------------------------------------
	548	loadConfig(globals())