Documentation/sphinx: add basic working Sphinx configuration and build
Add basic configuration and makefile to build documentation from any
.rst files under Documentation using Sphinx. For starters, there's just
the placeholder index.rst.
At the top level Makefile, hook Sphinx documentation targets alongside
(but independent of) the DocBook toolchain, having both be run on the
various 'make *docs' targets.
All Sphinx processing is placed into Documentation/Makefile.sphinx. Both
that and the Documentation/DocBook/Makefile are now expected to handle
all the documentation targets, explicitly ignoring them if they're not
relevant for that particular toolchain. The changes to the existing
DocBook Makefile are kept minimal.
There is graceful handling of missing Sphinx and rst2pdf (which is
needed for pdf output) by checking for the tool and python module,
respectively, with informative messages to the user.
If the Read the Docs theme (sphinx_rtd_theme) is available, use it, but
otherwise gracefully fall back to the Sphinx default theme, with an
informative message to the user, and slightly less pretty HTML output.
Sphinx can now handle htmldocs, pdfdocs (if rst2pdf is available),
epubdocs and xmldocs targets. The output documents are written into per
output type subdirectories under Documentation/output.
Finally, you can pass options to sphinx-build using the SPHINXBUILD make
variable. For example, 'make SPHINXOPTS=-v htmldocs' for more verbose
output from Sphinx.
This is based on the original work by Jonathan Corbet, but he probably
wouldn't recognize this as his own anymore.
Signed-off-by: Jani Nikula <jani.nikula@intel.com>
2016-05-19 20:14:05 +08:00
|
|
|
# -*- 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
|
2016-08-17 00:25:43 +08:00
|
|
|
import sphinx
|
2022-08-27 12:37:18 +08:00
|
|
|
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
|
2016-08-17 00:25:43 +08:00
|
|
|
|
|
|
|
# Get Sphinx version
|
2017-03-20 23:37:49 +08:00
|
|
|
major, minor, patch = sphinx.version_info[:3]
|
2016-08-17 00:25:43 +08:00
|
|
|
|
2023-01-05 04:59:16 +08:00
|
|
|
#
|
|
|
|
# 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.')
|
Documentation/sphinx: add basic working Sphinx configuration and build
Add basic configuration and makefile to build documentation from any
.rst files under Documentation using Sphinx. For starters, there's just
the placeholder index.rst.
At the top level Makefile, hook Sphinx documentation targets alongside
(but independent of) the DocBook toolchain, having both be run on the
various 'make *docs' targets.
All Sphinx processing is placed into Documentation/Makefile.sphinx. Both
that and the Documentation/DocBook/Makefile are now expected to handle
all the documentation targets, explicitly ignoring them if they're not
relevant for that particular toolchain. The changes to the existing
DocBook Makefile are kept minimal.
There is graceful handling of missing Sphinx and rst2pdf (which is
needed for pdf output) by checking for the tool and python module,
respectively, with informative messages to the user.
If the Read the Docs theme (sphinx_rtd_theme) is available, use it, but
otherwise gracefully fall back to the Sphinx default theme, with an
informative message to the user, and slightly less pretty HTML output.
Sphinx can now handle htmldocs, pdfdocs (if rst2pdf is available),
epubdocs and xmldocs targets. The output documents are written into per
output type subdirectories under Documentation/output.
Finally, you can pass options to sphinx-build using the SPHINXBUILD make
variable. For example, 'make SPHINXOPTS=-v htmldocs' for more verbose
output from Sphinx.
This is based on the original work by Jonathan Corbet, but he probably
wouldn't recognize this as his own anymore.
Signed-off-by: Jani Nikula <jani.nikula@intel.com>
2016-05-19 20:14:05 +08:00
|
|
|
|
|
|
|
# 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.
|
2016-05-20 16:51:47 +08:00
|
|
|
sys.path.insert(0, os.path.abspath('sphinx'))
|
2016-08-13 22:12:42 +08:00
|
|
|
from load_config import loadConfig
|
Documentation/sphinx: add basic working Sphinx configuration and build
Add basic configuration and makefile to build documentation from any
.rst files under Documentation using Sphinx. For starters, there's just
the placeholder index.rst.
At the top level Makefile, hook Sphinx documentation targets alongside
(but independent of) the DocBook toolchain, having both be run on the
various 'make *docs' targets.
All Sphinx processing is placed into Documentation/Makefile.sphinx. Both
that and the Documentation/DocBook/Makefile are now expected to handle
all the documentation targets, explicitly ignoring them if they're not
relevant for that particular toolchain. The changes to the existing
DocBook Makefile are kept minimal.
There is graceful handling of missing Sphinx and rst2pdf (which is
needed for pdf output) by checking for the tool and python module,
respectively, with informative messages to the user.
If the Read the Docs theme (sphinx_rtd_theme) is available, use it, but
otherwise gracefully fall back to the Sphinx default theme, with an
informative message to the user, and slightly less pretty HTML output.
Sphinx can now handle htmldocs, pdfdocs (if rst2pdf is available),
epubdocs and xmldocs targets. The output documents are written into per
output type subdirectories under Documentation/output.
Finally, you can pass options to sphinx-build using the SPHINXBUILD make
variable. For example, 'make SPHINXOPTS=-v htmldocs' for more verbose
output from Sphinx.
This is based on the original work by Jonathan Corbet, but he probably
wouldn't recognize this as his own anymore.
Signed-off-by: Jani Nikula <jani.nikula@intel.com>
2016-05-19 20:14:05 +08:00
|
|
|
|
|
|
|
# -- General configuration ------------------------------------------------
|
|
|
|
|
|
|
|
# If your documentation needs a minimal Sphinx version, state it here.
|
2021-02-02 07:26:25 +08:00
|
|
|
needs_sphinx = '1.7'
|
Documentation/sphinx: add basic working Sphinx configuration and build
Add basic configuration and makefile to build documentation from any
.rst files under Documentation using Sphinx. For starters, there's just
the placeholder index.rst.
At the top level Makefile, hook Sphinx documentation targets alongside
(but independent of) the DocBook toolchain, having both be run on the
various 'make *docs' targets.
All Sphinx processing is placed into Documentation/Makefile.sphinx. Both
that and the Documentation/DocBook/Makefile are now expected to handle
all the documentation targets, explicitly ignoring them if they're not
relevant for that particular toolchain. The changes to the existing
DocBook Makefile are kept minimal.
There is graceful handling of missing Sphinx and rst2pdf (which is
needed for pdf output) by checking for the tool and python module,
respectively, with informative messages to the user.
If the Read the Docs theme (sphinx_rtd_theme) is available, use it, but
otherwise gracefully fall back to the Sphinx default theme, with an
informative message to the user, and slightly less pretty HTML output.
Sphinx can now handle htmldocs, pdfdocs (if rst2pdf is available),
epubdocs and xmldocs targets. The output documents are written into per
output type subdirectories under Documentation/output.
Finally, you can pass options to sphinx-build using the SPHINXBUILD make
variable. For example, 'make SPHINXOPTS=-v htmldocs' for more verbose
output from Sphinx.
This is based on the original work by Jonathan Corbet, but he probably
wouldn't recognize this as his own anymore.
Signed-off-by: Jani Nikula <jani.nikula@intel.com>
2016-05-19 20:14:05 +08:00
|
|
|
|
|
|
|
# Add any Sphinx extension module names here, as strings. They can be
|
|
|
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
|
|
|
# ones.
|
2020-09-05 00:13:45 +08:00
|
|
|
extensions = ['kerneldoc', 'rstFlatTable', 'kernel_include',
|
2019-10-02 02:25:32 +08:00
|
|
|
'kfigure', 'sphinx.ext.ifconfig', 'automarkup',
|
2020-10-30 15:40:36 +08:00
|
|
|
'maintainers_include', 'sphinx.ext.autosectionlabel',
|
2020-11-30 23:36:34 +08:00
|
|
|
'kernel_abi', 'kernel_feat']
|
Documentation/sphinx: add basic working Sphinx configuration and build
Add basic configuration and makefile to build documentation from any
.rst files under Documentation using Sphinx. For starters, there's just
the placeholder index.rst.
At the top level Makefile, hook Sphinx documentation targets alongside
(but independent of) the DocBook toolchain, having both be run on the
various 'make *docs' targets.
All Sphinx processing is placed into Documentation/Makefile.sphinx. Both
that and the Documentation/DocBook/Makefile are now expected to handle
all the documentation targets, explicitly ignoring them if they're not
relevant for that particular toolchain. The changes to the existing
DocBook Makefile are kept minimal.
There is graceful handling of missing Sphinx and rst2pdf (which is
needed for pdf output) by checking for the tool and python module,
respectively, with informative messages to the user.
If the Read the Docs theme (sphinx_rtd_theme) is available, use it, but
otherwise gracefully fall back to the Sphinx default theme, with an
informative message to the user, and slightly less pretty HTML output.
Sphinx can now handle htmldocs, pdfdocs (if rst2pdf is available),
epubdocs and xmldocs targets. The output documents are written into per
output type subdirectories under Documentation/output.
Finally, you can pass options to sphinx-build using the SPHINXBUILD make
variable. For example, 'make SPHINXOPTS=-v htmldocs' for more verbose
output from Sphinx.
This is based on the original work by Jonathan Corbet, but he probably
wouldn't recognize this as his own anymore.
Signed-off-by: Jani Nikula <jani.nikula@intel.com>
2016-05-19 20:14:05 +08:00
|
|
|
|
2020-09-05 00:13:45 +08:00
|
|
|
if major >= 3:
|
2020-10-27 17:51:06 +08:00
|
|
|
if (major > 3) or (minor > 0 or patch >= 2):
|
2020-09-28 15:42:44 +08:00
|
|
|
# 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",
|
|
|
|
|
|
|
|
# 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",
|
2022-08-27 00:01:50 +08:00
|
|
|
"__fix_address",
|
2020-09-28 15:42:44 +08:00
|
|
|
|
|
|
|
# include/linux/memblock.h:
|
|
|
|
"__init_memblock",
|
|
|
|
"__meminit",
|
|
|
|
|
|
|
|
# include/linux/init.h:
|
|
|
|
"__init",
|
|
|
|
"__ref",
|
|
|
|
|
|
|
|
# include/linux/linkage.h:
|
|
|
|
"asmlinkage",
|
2023-02-02 01:30:14 +08:00
|
|
|
|
|
|
|
# include/linux/btf.h
|
|
|
|
"__bpf_kfunc",
|
2020-09-28 15:42:44 +08:00
|
|
|
]
|
|
|
|
|
2020-09-05 00:13:45 +08:00
|
|
|
else:
|
|
|
|
extensions.append('cdomain')
|
|
|
|
|
docs: conf.py: avoid thousands of duplicate label warning on Sphinx
The autosectionlabel extension is nice, as it allows to refer to
a section by its name without requiring any extra tag to create
a reference name.
However, on its default, it has two serious problems:
1) the namespace is global. So, two files with different
"introduction" section would create a label with the
same name. This is easily solvable by forcing the extension
to prepend the file name with:
autosectionlabel_prefix_document = True
2) It doesn't work hierarchically. So, if there are two level 1
sessions (let's say, one labeled "open" and another one "ioctl")
and both have a level 2 "synopsis" label, both section 2 will
have the same identical name.
Currently, there's no way to tell Sphinx to create an
hierarchical reference like:
open / synopsis
ioctl / synopsis
This causes around 800 warnings. So, the fix should be to
not let autosectionlabel to produce references for anything
that it is not at a chapter level within any doc, with:
autosectionlabel_maxdepth = 2
Fixes: 58ad30cf91f0 ("docs: fix reference to core-api/namespaces.rst")
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/74f4d8d91c648d7101c45b4b99cc93532f4dadc6.1584716446.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2020-03-20 23:11:03 +08:00
|
|
|
# Ensure that autosectionlabel will produce unique names
|
|
|
|
autosectionlabel_prefix_document = True
|
|
|
|
autosectionlabel_maxdepth = 2
|
|
|
|
|
2022-08-27 12:37:18 +08:00
|
|
|
# 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')
|
2022-08-27 12:38:17 +08:00
|
|
|
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)
|
2022-08-27 12:37:18 +08:00
|
|
|
or 'epub' in sys.argv)
|
|
|
|
|
|
|
|
if load_imgmath:
|
|
|
|
extensions.append("sphinx.ext.imgmath")
|
|
|
|
math_renderer = 'imgmath'
|
|
|
|
else:
|
|
|
|
math_renderer = 'mathjax'
|
Documentation/sphinx: add basic working Sphinx configuration and build
Add basic configuration and makefile to build documentation from any
.rst files under Documentation using Sphinx. For starters, there's just
the placeholder index.rst.
At the top level Makefile, hook Sphinx documentation targets alongside
(but independent of) the DocBook toolchain, having both be run on the
various 'make *docs' targets.
All Sphinx processing is placed into Documentation/Makefile.sphinx. Both
that and the Documentation/DocBook/Makefile are now expected to handle
all the documentation targets, explicitly ignoring them if they're not
relevant for that particular toolchain. The changes to the existing
DocBook Makefile are kept minimal.
There is graceful handling of missing Sphinx and rst2pdf (which is
needed for pdf output) by checking for the tool and python module,
respectively, with informative messages to the user.
If the Read the Docs theme (sphinx_rtd_theme) is available, use it, but
otherwise gracefully fall back to the Sphinx default theme, with an
informative message to the user, and slightly less pretty HTML output.
Sphinx can now handle htmldocs, pdfdocs (if rst2pdf is available),
epubdocs and xmldocs targets. The output documents are written into per
output type subdirectories under Documentation/output.
Finally, you can pass options to sphinx-build using the SPHINXBUILD make
variable. For example, 'make SPHINXOPTS=-v htmldocs' for more verbose
output from Sphinx.
This is based on the original work by Jonathan Corbet, but he probably
wouldn't recognize this as his own anymore.
Signed-off-by: Jani Nikula <jani.nikula@intel.com>
2016-05-19 20:14:05 +08:00
|
|
|
|
|
|
|
# Add any paths that contain templates here, relative to this directory.
|
2023-01-20 08:03:05 +08:00
|
|
|
templates_path = ['sphinx/templates']
|
Documentation/sphinx: add basic working Sphinx configuration and build
Add basic configuration and makefile to build documentation from any
.rst files under Documentation using Sphinx. For starters, there's just
the placeholder index.rst.
At the top level Makefile, hook Sphinx documentation targets alongside
(but independent of) the DocBook toolchain, having both be run on the
various 'make *docs' targets.
All Sphinx processing is placed into Documentation/Makefile.sphinx. Both
that and the Documentation/DocBook/Makefile are now expected to handle
all the documentation targets, explicitly ignoring them if they're not
relevant for that particular toolchain. The changes to the existing
DocBook Makefile are kept minimal.
There is graceful handling of missing Sphinx and rst2pdf (which is
needed for pdf output) by checking for the tool and python module,
respectively, with informative messages to the user.
If the Read the Docs theme (sphinx_rtd_theme) is available, use it, but
otherwise gracefully fall back to the Sphinx default theme, with an
informative message to the user, and slightly less pretty HTML output.
Sphinx can now handle htmldocs, pdfdocs (if rst2pdf is available),
epubdocs and xmldocs targets. The output documents are written into per
output type subdirectories under Documentation/output.
Finally, you can pass options to sphinx-build using the SPHINXBUILD make
variable. For example, 'make SPHINXOPTS=-v htmldocs' for more verbose
output from Sphinx.
This is based on the original work by Jonathan Corbet, but he probably
wouldn't recognize this as his own anymore.
Signed-off-by: Jani Nikula <jani.nikula@intel.com>
2016-05-19 20:14:05 +08:00
|
|
|
|
|
|
|
# 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'
|
2017-02-07 02:52:19 +08:00
|
|
|
copyright = 'The kernel development community'
|
Documentation/sphinx: add basic working Sphinx configuration and build
Add basic configuration and makefile to build documentation from any
.rst files under Documentation using Sphinx. For starters, there's just
the placeholder index.rst.
At the top level Makefile, hook Sphinx documentation targets alongside
(but independent of) the DocBook toolchain, having both be run on the
various 'make *docs' targets.
All Sphinx processing is placed into Documentation/Makefile.sphinx. Both
that and the Documentation/DocBook/Makefile are now expected to handle
all the documentation targets, explicitly ignoring them if they're not
relevant for that particular toolchain. The changes to the existing
DocBook Makefile are kept minimal.
There is graceful handling of missing Sphinx and rst2pdf (which is
needed for pdf output) by checking for the tool and python module,
respectively, with informative messages to the user.
If the Read the Docs theme (sphinx_rtd_theme) is available, use it, but
otherwise gracefully fall back to the Sphinx default theme, with an
informative message to the user, and slightly less pretty HTML output.
Sphinx can now handle htmldocs, pdfdocs (if rst2pdf is available),
epubdocs and xmldocs targets. The output documents are written into per
output type subdirectories under Documentation/output.
Finally, you can pass options to sphinx-build using the SPHINXBUILD make
variable. For example, 'make SPHINXOPTS=-v htmldocs' for more verbose
output from Sphinx.
This is based on the original work by Jonathan Corbet, but he probably
wouldn't recognize this as his own anymore.
Signed-off-by: Jani Nikula <jani.nikula@intel.com>
2016-05-19 20:14:05 +08:00
|
|
|
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.
|
|
|
|
#
|
2016-05-28 20:25:41 +08:00
|
|
|
# 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"
|
Documentation/sphinx: add basic working Sphinx configuration and build
Add basic configuration and makefile to build documentation from any
.rst files under Documentation using Sphinx. For starters, there's just
the placeholder index.rst.
At the top level Makefile, hook Sphinx documentation targets alongside
(but independent of) the DocBook toolchain, having both be run on the
various 'make *docs' targets.
All Sphinx processing is placed into Documentation/Makefile.sphinx. Both
that and the Documentation/DocBook/Makefile are now expected to handle
all the documentation targets, explicitly ignoring them if they're not
relevant for that particular toolchain. The changes to the existing
DocBook Makefile are kept minimal.
There is graceful handling of missing Sphinx and rst2pdf (which is
needed for pdf output) by checking for the tool and python module,
respectively, with informative messages to the user.
If the Read the Docs theme (sphinx_rtd_theme) is available, use it, but
otherwise gracefully fall back to the Sphinx default theme, with an
informative message to the user, and slightly less pretty HTML output.
Sphinx can now handle htmldocs, pdfdocs (if rst2pdf is available),
epubdocs and xmldocs targets. The output documents are written into per
output type subdirectories under Documentation/output.
Finally, you can pass options to sphinx-build using the SPHINXBUILD make
variable. For example, 'make SPHINXOPTS=-v htmldocs' for more verbose
output from Sphinx.
This is based on the original work by Jonathan Corbet, but he probably
wouldn't recognize this as his own anymore.
Signed-off-by: Jani Nikula <jani.nikula@intel.com>
2016-05-19 20:14:05 +08:00
|
|
|
|
2022-09-24 06:28:57 +08:00
|
|
|
#
|
|
|
|
# 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
|
|
|
|
|
Documentation/sphinx: add basic working Sphinx configuration and build
Add basic configuration and makefile to build documentation from any
.rst files under Documentation using Sphinx. For starters, there's just
the placeholder index.rst.
At the top level Makefile, hook Sphinx documentation targets alongside
(but independent of) the DocBook toolchain, having both be run on the
various 'make *docs' targets.
All Sphinx processing is placed into Documentation/Makefile.sphinx. Both
that and the Documentation/DocBook/Makefile are now expected to handle
all the documentation targets, explicitly ignoring them if they're not
relevant for that particular toolchain. The changes to the existing
DocBook Makefile are kept minimal.
There is graceful handling of missing Sphinx and rst2pdf (which is
needed for pdf output) by checking for the tool and python module,
respectively, with informative messages to the user.
If the Read the Docs theme (sphinx_rtd_theme) is available, use it, but
otherwise gracefully fall back to the Sphinx default theme, with an
informative message to the user, and slightly less pretty HTML output.
Sphinx can now handle htmldocs, pdfdocs (if rst2pdf is available),
epubdocs and xmldocs targets. The output documents are written into per
output type subdirectories under Documentation/output.
Finally, you can pass options to sphinx-build using the SPHINXBUILD make
variable. For example, 'make SPHINXOPTS=-v htmldocs' for more verbose
output from Sphinx.
This is based on the original work by Jonathan Corbet, but he probably
wouldn't recognize this as his own anymore.
Signed-off-by: Jani Nikula <jani.nikula@intel.com>
2016-05-19 20:14:05 +08:00
|
|
|
# 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.
|
2022-06-01 22:34:06 +08:00
|
|
|
language = 'en'
|
Documentation/sphinx: add basic working Sphinx configuration and build
Add basic configuration and makefile to build documentation from any
.rst files under Documentation using Sphinx. For starters, there's just
the placeholder index.rst.
At the top level Makefile, hook Sphinx documentation targets alongside
(but independent of) the DocBook toolchain, having both be run on the
various 'make *docs' targets.
All Sphinx processing is placed into Documentation/Makefile.sphinx. Both
that and the Documentation/DocBook/Makefile are now expected to handle
all the documentation targets, explicitly ignoring them if they're not
relevant for that particular toolchain. The changes to the existing
DocBook Makefile are kept minimal.
There is graceful handling of missing Sphinx and rst2pdf (which is
needed for pdf output) by checking for the tool and python module,
respectively, with informative messages to the user.
If the Read the Docs theme (sphinx_rtd_theme) is available, use it, but
otherwise gracefully fall back to the Sphinx default theme, with an
informative message to the user, and slightly less pretty HTML output.
Sphinx can now handle htmldocs, pdfdocs (if rst2pdf is available),
epubdocs and xmldocs targets. The output documents are written into per
output type subdirectories under Documentation/output.
Finally, you can pass options to sphinx-build using the SPHINXBUILD make
variable. For example, 'make SPHINXOPTS=-v htmldocs' for more verbose
output from Sphinx.
This is based on the original work by Jonathan Corbet, but he probably
wouldn't recognize this as his own anymore.
Signed-off-by: Jani Nikula <jani.nikula@intel.com>
2016-05-19 20:14:05 +08:00
|
|
|
|
|
|
|
# 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
|
|
|
|
|
2017-03-03 20:24:05 +08:00
|
|
|
primary_domain = 'c'
|
Documentation/sphinx: set literal block highlight language to none
Set the default highlight language to "none", i.e. do not try to guess
the language and do automatic syntax highlighting on literal blocks.
Eyeballing around the generated documentation, we don't seem to actually
have a lot of literal blocks that would benefit from syntax
highlighting. The C code blocks we do have are typically very short, and
most of the literal blocks are things that shouldn't be highlighted (or,
do not have a pygments lexer). This seems to be true for literal blocks
both in the rst source files and in source code comments.
Not highlighting code is never wrong, but guessing the language wrong
almost invariably leads to silly or confusing highlighting.
At the time of writing, admin-guide/oops-tracing.rst and
admin-guide/ramoops.rst contain good examples of 1) a small C code
snippet not highlighted, 2) a hex dump highligted as who knows what, 3)
device tree block highlighted as C or maybe Python, 4) a terminal
interaction highlighted as code in some language, and finally, 5) some C
code snippets correctly identified as C. I think we're better off
disabling language guessing, and going by explicitly identified
languages for longer code blocks.
It is still possible to enable highlighting on an rst source file basis
using the highlight directive:
.. higlight:: language
and on a literal block basis using the code-block directive:
.. code-block:: language
See http://www.sphinx-doc.org/en/latest/markup/code.html for details.
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
Cc: Markus Heiser <markus.heiser@darmarit.de>
Signed-off-by: Jani Nikula <jani.nikula@intel.com>
2016-11-03 16:26:54 +08:00
|
|
|
highlight_language = 'none'
|
Documentation/sphinx: add basic working Sphinx configuration and build
Add basic configuration and makefile to build documentation from any
.rst files under Documentation using Sphinx. For starters, there's just
the placeholder index.rst.
At the top level Makefile, hook Sphinx documentation targets alongside
(but independent of) the DocBook toolchain, having both be run on the
various 'make *docs' targets.
All Sphinx processing is placed into Documentation/Makefile.sphinx. Both
that and the Documentation/DocBook/Makefile are now expected to handle
all the documentation targets, explicitly ignoring them if they're not
relevant for that particular toolchain. The changes to the existing
DocBook Makefile are kept minimal.
There is graceful handling of missing Sphinx and rst2pdf (which is
needed for pdf output) by checking for the tool and python module,
respectively, with informative messages to the user.
If the Read the Docs theme (sphinx_rtd_theme) is available, use it, but
otherwise gracefully fall back to the Sphinx default theme, with an
informative message to the user, and slightly less pretty HTML output.
Sphinx can now handle htmldocs, pdfdocs (if rst2pdf is available),
epubdocs and xmldocs targets. The output documents are written into per
output type subdirectories under Documentation/output.
Finally, you can pass options to sphinx-build using the SPHINXBUILD make
variable. For example, 'make SPHINXOPTS=-v htmldocs' for more verbose
output from Sphinx.
This is based on the original work by Jonathan Corbet, but he probably
wouldn't recognize this as his own anymore.
Signed-off-by: Jani Nikula <jani.nikula@intel.com>
2016-05-19 20:14:05 +08:00
|
|
|
|
|
|
|
# -- Options for HTML output ----------------------------------------------
|
|
|
|
|
|
|
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
|
|
|
# a list of builtin themes.
|
|
|
|
|
2021-12-07 17:52:59 +08:00
|
|
|
# Default theme
|
2022-09-24 06:28:57 +08:00
|
|
|
html_theme = 'alabaster'
|
2021-12-07 17:53:00 +08:00
|
|
|
html_css_files = []
|
2021-12-07 17:52:59 +08:00
|
|
|
|
|
|
|
if "DOCS_THEME" in os.environ:
|
|
|
|
html_theme = os.environ["DOCS_THEME"]
|
|
|
|
|
docs: add support for RTD dark mode
This is actually an overlay on the top of the RTD theme, which
requires to include first the RTD theme.
It should be noticed that, when the dark theme is used, the
DOCS_CSS files won't be the last CSS themes. So, it won't
override the dark.css style by default. So, it is needed
to force the them override with "!important".
This small script, for instance, produces a nice output with
the RTD dark theme:
DOCS_THEME=sphinx_rtd_dark_mode
cat << EOF > dark_override.css
html body {
font-family: arial,helvetica,sans-serif;
}
html[data-theme='dark'] body {
color: white !important;
}
html[data-theme='dark'] .sig-name {
color: green !important;
}
html[data-theme='dark'] .wy-menu-vertical a {
color: #ffcc00 !important;
}
html[data-theme="dark"] h1, html[data-theme="dark"] h2, html[data-theme="dark"] h3 {
color: #ffcc00 !important;
}
html[data-theme="dark"] h4, html[data-theme="dark"] h5, html[data-theme="dark"] h6 {
color: #ffcc00 !important;
}
html[data-theme="dark"] h7, html[data-theme="dark"] h8, html[data-theme="dark"] h9 {
color: #ffcc00 !important;
}
html[data-theme="dark"] .wy-nav-content a, html[data-theme="dark"] .wy-nav-content a:visited {
color: #ffcc00 !important;
}
EOF
make DOCS_CSS=dark_override.css DOCS_THEME=sphinx_rtd_dark_mode htmldocs
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/90d316e055ef7f4c9021b9eada8f8d3b2e750a66.1638870323.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2021-12-07 17:53:02 +08:00
|
|
|
if html_theme == 'sphinx_rtd_theme' or html_theme == 'sphinx_rtd_dark_mode':
|
2021-12-07 17:52:59 +08:00
|
|
|
# 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',
|
|
|
|
]
|
docs: add support for RTD dark mode
This is actually an overlay on the top of the RTD theme, which
requires to include first the RTD theme.
It should be noticed that, when the dark theme is used, the
DOCS_CSS files won't be the last CSS themes. So, it won't
override the dark.css style by default. So, it is needed
to force the them override with "!important".
This small script, for instance, produces a nice output with
the RTD dark theme:
DOCS_THEME=sphinx_rtd_dark_mode
cat << EOF > dark_override.css
html body {
font-family: arial,helvetica,sans-serif;
}
html[data-theme='dark'] body {
color: white !important;
}
html[data-theme='dark'] .sig-name {
color: green !important;
}
html[data-theme='dark'] .wy-menu-vertical a {
color: #ffcc00 !important;
}
html[data-theme="dark"] h1, html[data-theme="dark"] h2, html[data-theme="dark"] h3 {
color: #ffcc00 !important;
}
html[data-theme="dark"] h4, html[data-theme="dark"] h5, html[data-theme="dark"] h6 {
color: #ffcc00 !important;
}
html[data-theme="dark"] h7, html[data-theme="dark"] h8, html[data-theme="dark"] h9 {
color: #ffcc00 !important;
}
html[data-theme="dark"] .wy-nav-content a, html[data-theme="dark"] .wy-nav-content a:visited {
color: #ffcc00 !important;
}
EOF
make DOCS_CSS=dark_override.css DOCS_THEME=sphinx_rtd_dark_mode htmldocs
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/90d316e055ef7f4c9021b9eada8f8d3b2e750a66.1638870323.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2021-12-07 17:53:02 +08:00
|
|
|
|
|
|
|
# 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')
|
|
|
|
|
2022-11-08 19:57:07 +08:00
|
|
|
html_theme_options = {
|
|
|
|
'navigation_depth': -1,
|
|
|
|
}
|
|
|
|
|
2021-12-07 17:52:59 +08:00
|
|
|
except ImportError:
|
2022-10-12 01:25:25 +08:00
|
|
|
html_theme = 'alabaster'
|
2021-12-07 17:52:59 +08:00
|
|
|
|
2021-12-07 17:53:00 +08:00
|
|
|
if "DOCS_CSS" in os.environ:
|
|
|
|
css = os.environ["DOCS_CSS"].split(" ")
|
|
|
|
|
|
|
|
for l in css:
|
|
|
|
html_css_files.append(l)
|
|
|
|
|
2021-12-07 17:52:59 +08:00
|
|
|
if major <= 1 and minor < 8:
|
|
|
|
html_context = {
|
|
|
|
'css_files': [],
|
|
|
|
}
|
|
|
|
|
|
|
|
for l in html_css_files:
|
|
|
|
html_context['css_files'].append('_static/' + l)
|
|
|
|
|
2022-10-12 01:25:25 +08:00
|
|
|
if html_theme == 'alabaster':
|
2022-09-24 06:28:57 +08:00
|
|
|
html_theme_options = {
|
|
|
|
'description': get_cline_version(),
|
2022-09-27 07:48:59 +08:00
|
|
|
'page_width': '65em',
|
|
|
|
'sidebar_width': '15em',
|
2023-01-20 08:03:05 +08:00
|
|
|
'fixed_sidebar': 'true',
|
2022-11-01 00:48:19 +08:00
|
|
|
'font_size': 'inherit',
|
|
|
|
'font_family': 'serif',
|
2022-09-24 06:28:57 +08:00
|
|
|
}
|
2021-12-07 17:53:01 +08:00
|
|
|
|
2021-12-07 17:52:59 +08:00
|
|
|
sys.stderr.write("Using %s theme\n" % html_theme)
|
Documentation/sphinx: add basic working Sphinx configuration and build
Add basic configuration and makefile to build documentation from any
.rst files under Documentation using Sphinx. For starters, there's just
the placeholder index.rst.
At the top level Makefile, hook Sphinx documentation targets alongside
(but independent of) the DocBook toolchain, having both be run on the
various 'make *docs' targets.
All Sphinx processing is placed into Documentation/Makefile.sphinx. Both
that and the Documentation/DocBook/Makefile are now expected to handle
all the documentation targets, explicitly ignoring them if they're not
relevant for that particular toolchain. The changes to the existing
DocBook Makefile are kept minimal.
There is graceful handling of missing Sphinx and rst2pdf (which is
needed for pdf output) by checking for the tool and python module,
respectively, with informative messages to the user.
If the Read the Docs theme (sphinx_rtd_theme) is available, use it, but
otherwise gracefully fall back to the Sphinx default theme, with an
informative message to the user, and slightly less pretty HTML output.
Sphinx can now handle htmldocs, pdfdocs (if rst2pdf is available),
epubdocs and xmldocs targets. The output documents are written into per
output type subdirectories under Documentation/output.
Finally, you can pass options to sphinx-build using the SPHINXBUILD make
variable. For example, 'make SPHINXOPTS=-v htmldocs' for more verbose
output from Sphinx.
This is based on the original work by Jonathan Corbet, but he probably
wouldn't recognize this as his own anymore.
Signed-off-by: Jani Nikula <jani.nikula@intel.com>
2016-05-19 20:14:05 +08:00
|
|
|
|
|
|
|
# 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".
|
2016-07-03 16:05:28 +08:00
|
|
|
html_static_path = ['sphinx-static']
|
|
|
|
|
Documentation/sphinx: add basic working Sphinx configuration and build
Add basic configuration and makefile to build documentation from any
.rst files under Documentation using Sphinx. For starters, there's just
the placeholder index.rst.
At the top level Makefile, hook Sphinx documentation targets alongside
(but independent of) the DocBook toolchain, having both be run on the
various 'make *docs' targets.
All Sphinx processing is placed into Documentation/Makefile.sphinx. Both
that and the Documentation/DocBook/Makefile are now expected to handle
all the documentation targets, explicitly ignoring them if they're not
relevant for that particular toolchain. The changes to the existing
DocBook Makefile are kept minimal.
There is graceful handling of missing Sphinx and rst2pdf (which is
needed for pdf output) by checking for the tool and python module,
respectively, with informative messages to the user.
If the Read the Docs theme (sphinx_rtd_theme) is available, use it, but
otherwise gracefully fall back to the Sphinx default theme, with an
informative message to the user, and slightly less pretty HTML output.
Sphinx can now handle htmldocs, pdfdocs (if rst2pdf is available),
epubdocs and xmldocs targets. The output documents are written into per
output type subdirectories under Documentation/output.
Finally, you can pass options to sphinx-build using the SPHINXBUILD make
variable. For example, 'make SPHINXOPTS=-v htmldocs' for more verbose
output from Sphinx.
This is based on the original work by Jonathan Corbet, but he probably
wouldn't recognize this as his own anymore.
Signed-off-by: Jani Nikula <jani.nikula@intel.com>
2016-05-19 20:14:05 +08:00
|
|
|
# If true, SmartyPants will be used to convert quotes and dashes to
|
|
|
|
# typographically correct entities.
|
2019-06-29 02:38:41 +08:00
|
|
|
html_use_smartypants = False
|
Documentation/sphinx: add basic working Sphinx configuration and build
Add basic configuration and makefile to build documentation from any
.rst files under Documentation using Sphinx. For starters, there's just
the placeholder index.rst.
At the top level Makefile, hook Sphinx documentation targets alongside
(but independent of) the DocBook toolchain, having both be run on the
various 'make *docs' targets.
All Sphinx processing is placed into Documentation/Makefile.sphinx. Both
that and the Documentation/DocBook/Makefile are now expected to handle
all the documentation targets, explicitly ignoring them if they're not
relevant for that particular toolchain. The changes to the existing
DocBook Makefile are kept minimal.
There is graceful handling of missing Sphinx and rst2pdf (which is
needed for pdf output) by checking for the tool and python module,
respectively, with informative messages to the user.
If the Read the Docs theme (sphinx_rtd_theme) is available, use it, but
otherwise gracefully fall back to the Sphinx default theme, with an
informative message to the user, and slightly less pretty HTML output.
Sphinx can now handle htmldocs, pdfdocs (if rst2pdf is available),
epubdocs and xmldocs targets. The output documents are written into per
output type subdirectories under Documentation/output.
Finally, you can pass options to sphinx-build using the SPHINXBUILD make
variable. For example, 'make SPHINXOPTS=-v htmldocs' for more verbose
output from Sphinx.
This is based on the original work by Jonathan Corbet, but he probably
wouldn't recognize this as his own anymore.
Signed-off-by: Jani Nikula <jani.nikula@intel.com>
2016-05-19 20:14:05 +08:00
|
|
|
|
|
|
|
# Custom sidebar templates, maps document names to template names.
|
2022-09-24 06:28:57 +08:00
|
|
|
# Note that the RTD theme ignores this
|
2023-01-20 08:03:05 +08:00
|
|
|
html_sidebars = { '**': ['searchbox.html', 'kernel-toc.html', 'sourcelink.html']}
|
2023-01-10 17:47:25 +08:00
|
|
|
|
|
|
|
# about.html is available for alabaster theme. Add it at the front.
|
|
|
|
if html_theme == 'alabaster':
|
|
|
|
html_sidebars['**'].insert(0, 'about.html')
|
Documentation/sphinx: add basic working Sphinx configuration and build
Add basic configuration and makefile to build documentation from any
.rst files under Documentation using Sphinx. For starters, there's just
the placeholder index.rst.
At the top level Makefile, hook Sphinx documentation targets alongside
(but independent of) the DocBook toolchain, having both be run on the
various 'make *docs' targets.
All Sphinx processing is placed into Documentation/Makefile.sphinx. Both
that and the Documentation/DocBook/Makefile are now expected to handle
all the documentation targets, explicitly ignoring them if they're not
relevant for that particular toolchain. The changes to the existing
DocBook Makefile are kept minimal.
There is graceful handling of missing Sphinx and rst2pdf (which is
needed for pdf output) by checking for the tool and python module,
respectively, with informative messages to the user.
If the Read the Docs theme (sphinx_rtd_theme) is available, use it, but
otherwise gracefully fall back to the Sphinx default theme, with an
informative message to the user, and slightly less pretty HTML output.
Sphinx can now handle htmldocs, pdfdocs (if rst2pdf is available),
epubdocs and xmldocs targets. The output documents are written into per
output type subdirectories under Documentation/output.
Finally, you can pass options to sphinx-build using the SPHINXBUILD make
variable. For example, 'make SPHINXOPTS=-v htmldocs' for more verbose
output from Sphinx.
This is based on the original work by Jonathan Corbet, but he probably
wouldn't recognize this as his own anymore.
Signed-off-by: Jani Nikula <jani.nikula@intel.com>
2016-05-19 20:14:05 +08:00
|
|
|
|
|
|
|
# Output file base name for HTML help builder.
|
|
|
|
htmlhelp_basename = 'TheLinuxKerneldoc'
|
|
|
|
|
|
|
|
# -- Options for LaTeX output ---------------------------------------------
|
|
|
|
|
|
|
|
latex_elements = {
|
2021-03-03 23:58:00 +08:00
|
|
|
# The paper size ('letterpaper' or 'a4paper').
|
|
|
|
'papersize': 'a4paper',
|
Documentation/sphinx: add basic working Sphinx configuration and build
Add basic configuration and makefile to build documentation from any
.rst files under Documentation using Sphinx. For starters, there's just
the placeholder index.rst.
At the top level Makefile, hook Sphinx documentation targets alongside
(but independent of) the DocBook toolchain, having both be run on the
various 'make *docs' targets.
All Sphinx processing is placed into Documentation/Makefile.sphinx. Both
that and the Documentation/DocBook/Makefile are now expected to handle
all the documentation targets, explicitly ignoring them if they're not
relevant for that particular toolchain. The changes to the existing
DocBook Makefile are kept minimal.
There is graceful handling of missing Sphinx and rst2pdf (which is
needed for pdf output) by checking for the tool and python module,
respectively, with informative messages to the user.
If the Read the Docs theme (sphinx_rtd_theme) is available, use it, but
otherwise gracefully fall back to the Sphinx default theme, with an
informative message to the user, and slightly less pretty HTML output.
Sphinx can now handle htmldocs, pdfdocs (if rst2pdf is available),
epubdocs and xmldocs targets. The output documents are written into per
output type subdirectories under Documentation/output.
Finally, you can pass options to sphinx-build using the SPHINXBUILD make
variable. For example, 'make SPHINXOPTS=-v htmldocs' for more verbose
output from Sphinx.
This is based on the original work by Jonathan Corbet, but he probably
wouldn't recognize this as his own anymore.
Signed-off-by: Jani Nikula <jani.nikula@intel.com>
2016-05-19 20:14:05 +08:00
|
|
|
|
2021-03-03 23:58:00 +08:00
|
|
|
# The font size ('10pt', '11pt' or '12pt').
|
|
|
|
'pointsize': '11pt',
|
Documentation/sphinx: add basic working Sphinx configuration and build
Add basic configuration and makefile to build documentation from any
.rst files under Documentation using Sphinx. For starters, there's just
the placeholder index.rst.
At the top level Makefile, hook Sphinx documentation targets alongside
(but independent of) the DocBook toolchain, having both be run on the
various 'make *docs' targets.
All Sphinx processing is placed into Documentation/Makefile.sphinx. Both
that and the Documentation/DocBook/Makefile are now expected to handle
all the documentation targets, explicitly ignoring them if they're not
relevant for that particular toolchain. The changes to the existing
DocBook Makefile are kept minimal.
There is graceful handling of missing Sphinx and rst2pdf (which is
needed for pdf output) by checking for the tool and python module,
respectively, with informative messages to the user.
If the Read the Docs theme (sphinx_rtd_theme) is available, use it, but
otherwise gracefully fall back to the Sphinx default theme, with an
informative message to the user, and slightly less pretty HTML output.
Sphinx can now handle htmldocs, pdfdocs (if rst2pdf is available),
epubdocs and xmldocs targets. The output documents are written into per
output type subdirectories under Documentation/output.
Finally, you can pass options to sphinx-build using the SPHINXBUILD make
variable. For example, 'make SPHINXOPTS=-v htmldocs' for more verbose
output from Sphinx.
This is based on the original work by Jonathan Corbet, but he probably
wouldn't recognize this as his own anymore.
Signed-off-by: Jani Nikula <jani.nikula@intel.com>
2016-05-19 20:14:05 +08:00
|
|
|
|
2021-03-03 23:58:00 +08:00
|
|
|
# Latex figure (float) alignment
|
|
|
|
#'figure_align': 'htbp',
|
2016-08-17 00:25:37 +08:00
|
|
|
|
2021-03-03 23:58:00 +08:00
|
|
|
# Don't mangle with UTF-8 chars
|
|
|
|
'inputenc': '',
|
|
|
|
'utf8extra': '',
|
2016-08-17 00:25:39 +08:00
|
|
|
|
2021-03-03 23:58:00 +08:00
|
|
|
# Set document margins
|
|
|
|
'sphinxsetup': '''
|
|
|
|
hmargin=0.5in, vmargin=1in,
|
|
|
|
parsedliteralwraps=true,
|
|
|
|
verbatimhintsturnover=false,
|
|
|
|
''',
|
|
|
|
|
2021-08-09 09:23:57 +08:00
|
|
|
# For CJK One-half spacing, need to be in front of hyperref
|
|
|
|
'extrapackages': r'\usepackage{setspace}',
|
|
|
|
|
2021-03-03 23:58:00 +08:00
|
|
|
# Additional stuff for the LaTeX preamble.
|
2016-08-17 00:25:37 +08:00
|
|
|
'preamble': '''
|
2021-03-03 23:58:00 +08:00
|
|
|
% Use some font with UTF-8 support with XeLaTeX
|
2017-09-04 03:12:46 +08:00
|
|
|
\\usepackage{fontspec}
|
2018-10-05 09:06:03 +08:00
|
|
|
\\setsansfont{DejaVu Sans}
|
|
|
|
\\setromanfont{DejaVu Serif}
|
2017-09-04 03:12:46 +08:00
|
|
|
\\setmonofont{DejaVu Sans Mono}
|
2022-02-18 22:11:17 +08:00
|
|
|
''',
|
2019-07-14 18:16:18 +08:00
|
|
|
}
|
2017-09-04 03:12:46 +08:00
|
|
|
|
|
|
|
# Fix reference escape troubles with Sphinx 1.4.x
|
2021-02-02 07:26:25 +08:00
|
|
|
if major == 1:
|
2017-09-04 03:12:46 +08:00
|
|
|
latex_elements['preamble'] += '\\renewcommand*{\\DUrole}[2]{ #2 }\n'
|
|
|
|
|
2022-02-18 22:11:17 +08:00
|
|
|
|
|
|
|
# Load kerneldoc specific LaTeX settings
|
|
|
|
latex_elements['preamble'] += '''
|
|
|
|
% Load kerneldoc specific LaTeX settings
|
|
|
|
\\input{kerneldoc-preamble.sty}
|
|
|
|
'''
|
|
|
|
|
2017-09-04 03:12:46 +08:00
|
|
|
# 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.
|
2017-06-19 18:49:06 +08:00
|
|
|
|
Documentation/sphinx: add basic working Sphinx configuration and build
Add basic configuration and makefile to build documentation from any
.rst files under Documentation using Sphinx. For starters, there's just
the placeholder index.rst.
At the top level Makefile, hook Sphinx documentation targets alongside
(but independent of) the DocBook toolchain, having both be run on the
various 'make *docs' targets.
All Sphinx processing is placed into Documentation/Makefile.sphinx. Both
that and the Documentation/DocBook/Makefile are now expected to handle
all the documentation targets, explicitly ignoring them if they're not
relevant for that particular toolchain. The changes to the existing
DocBook Makefile are kept minimal.
There is graceful handling of missing Sphinx and rst2pdf (which is
needed for pdf output) by checking for the tool and python module,
respectively, with informative messages to the user.
If the Read the Docs theme (sphinx_rtd_theme) is available, use it, but
otherwise gracefully fall back to the Sphinx default theme, with an
informative message to the user, and slightly less pretty HTML output.
Sphinx can now handle htmldocs, pdfdocs (if rst2pdf is available),
epubdocs and xmldocs targets. The output documents are written into per
output type subdirectories under Documentation/output.
Finally, you can pass options to sphinx-build using the SPHINXBUILD make
variable. For example, 'make SPHINXOPTS=-v htmldocs' for more verbose
output from Sphinx.
This is based on the original work by Jonathan Corbet, but he probably
wouldn't recognize this as his own anymore.
Signed-off-by: Jani Nikula <jani.nikula@intel.com>
2016-05-19 20:14:05 +08:00
|
|
|
# Grouping the document tree into LaTeX files. List of tuples
|
|
|
|
# (source start file, target name, title,
|
|
|
|
# author, documentclass [howto, manual, or own class]).
|
2017-05-12 17:02:12 +08:00
|
|
|
# Sorted in alphabetical order
|
Documentation/sphinx: add basic working Sphinx configuration and build
Add basic configuration and makefile to build documentation from any
.rst files under Documentation using Sphinx. For starters, there's just
the placeholder index.rst.
At the top level Makefile, hook Sphinx documentation targets alongside
(but independent of) the DocBook toolchain, having both be run on the
various 'make *docs' targets.
All Sphinx processing is placed into Documentation/Makefile.sphinx. Both
that and the Documentation/DocBook/Makefile are now expected to handle
all the documentation targets, explicitly ignoring them if they're not
relevant for that particular toolchain. The changes to the existing
DocBook Makefile are kept minimal.
There is graceful handling of missing Sphinx and rst2pdf (which is
needed for pdf output) by checking for the tool and python module,
respectively, with informative messages to the user.
If the Read the Docs theme (sphinx_rtd_theme) is available, use it, but
otherwise gracefully fall back to the Sphinx default theme, with an
informative message to the user, and slightly less pretty HTML output.
Sphinx can now handle htmldocs, pdfdocs (if rst2pdf is available),
epubdocs and xmldocs targets. The output documents are written into per
output type subdirectories under Documentation/output.
Finally, you can pass options to sphinx-build using the SPHINXBUILD make
variable. For example, 'make SPHINXOPTS=-v htmldocs' for more verbose
output from Sphinx.
This is based on the original work by Jonathan Corbet, but he probably
wouldn't recognize this as his own anymore.
Signed-off-by: Jani Nikula <jani.nikula@intel.com>
2016-05-19 20:14:05 +08:00
|
|
|
latex_documents = [
|
|
|
|
]
|
|
|
|
|
2019-07-09 17:52:36 +08:00
|
|
|
# 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'))
|
|
|
|
|
Documentation/sphinx: add basic working Sphinx configuration and build
Add basic configuration and makefile to build documentation from any
.rst files under Documentation using Sphinx. For starters, there's just
the placeholder index.rst.
At the top level Makefile, hook Sphinx documentation targets alongside
(but independent of) the DocBook toolchain, having both be run on the
various 'make *docs' targets.
All Sphinx processing is placed into Documentation/Makefile.sphinx. Both
that and the Documentation/DocBook/Makefile are now expected to handle
all the documentation targets, explicitly ignoring them if they're not
relevant for that particular toolchain. The changes to the existing
DocBook Makefile are kept minimal.
There is graceful handling of missing Sphinx and rst2pdf (which is
needed for pdf output) by checking for the tool and python module,
respectively, with informative messages to the user.
If the Read the Docs theme (sphinx_rtd_theme) is available, use it, but
otherwise gracefully fall back to the Sphinx default theme, with an
informative message to the user, and slightly less pretty HTML output.
Sphinx can now handle htmldocs, pdfdocs (if rst2pdf is available),
epubdocs and xmldocs targets. The output documents are written into per
output type subdirectories under Documentation/output.
Finally, you can pass options to sphinx-build using the SPHINXBUILD make
variable. For example, 'make SPHINXOPTS=-v htmldocs' for more verbose
output from Sphinx.
This is based on the original work by Jonathan Corbet, but he probably
wouldn't recognize this as his own anymore.
Signed-off-by: Jani Nikula <jani.nikula@intel.com>
2016-05-19 20:14:05 +08:00
|
|
|
# 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
|
|
|
|
|
2022-02-18 22:11:17 +08:00
|
|
|
# Additional LaTeX stuff to be copied to build directory
|
|
|
|
latex_additional_files = [
|
|
|
|
'sphinx/kerneldoc-preamble.sty',
|
|
|
|
]
|
|
|
|
|
Documentation/sphinx: add basic working Sphinx configuration and build
Add basic configuration and makefile to build documentation from any
.rst files under Documentation using Sphinx. For starters, there's just
the placeholder index.rst.
At the top level Makefile, hook Sphinx documentation targets alongside
(but independent of) the DocBook toolchain, having both be run on the
various 'make *docs' targets.
All Sphinx processing is placed into Documentation/Makefile.sphinx. Both
that and the Documentation/DocBook/Makefile are now expected to handle
all the documentation targets, explicitly ignoring them if they're not
relevant for that particular toolchain. The changes to the existing
DocBook Makefile are kept minimal.
There is graceful handling of missing Sphinx and rst2pdf (which is
needed for pdf output) by checking for the tool and python module,
respectively, with informative messages to the user.
If the Read the Docs theme (sphinx_rtd_theme) is available, use it, but
otherwise gracefully fall back to the Sphinx default theme, with an
informative message to the user, and slightly less pretty HTML output.
Sphinx can now handle htmldocs, pdfdocs (if rst2pdf is available),
epubdocs and xmldocs targets. The output documents are written into per
output type subdirectories under Documentation/output.
Finally, you can pass options to sphinx-build using the SPHINXBUILD make
variable. For example, 'make SPHINXOPTS=-v htmldocs' for more verbose
output from Sphinx.
This is based on the original work by Jonathan Corbet, but he probably
wouldn't recognize this as his own anymore.
Signed-off-by: Jani Nikula <jani.nikula@intel.com>
2016-05-19 20:14:05 +08:00
|
|
|
|
|
|
|
# -- 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).
|
|
|
|
#
|
2020-05-26 14:05:44 +08:00
|
|
|
# See the Sphinx chapter of https://ralsina.me/static/manual.pdf
|
Documentation/sphinx: add basic working Sphinx configuration and build
Add basic configuration and makefile to build documentation from any
.rst files under Documentation using Sphinx. For starters, there's just
the placeholder index.rst.
At the top level Makefile, hook Sphinx documentation targets alongside
(but independent of) the DocBook toolchain, having both be run on the
various 'make *docs' targets.
All Sphinx processing is placed into Documentation/Makefile.sphinx. Both
that and the Documentation/DocBook/Makefile are now expected to handle
all the documentation targets, explicitly ignoring them if they're not
relevant for that particular toolchain. The changes to the existing
DocBook Makefile are kept minimal.
There is graceful handling of missing Sphinx and rst2pdf (which is
needed for pdf output) by checking for the tool and python module,
respectively, with informative messages to the user.
If the Read the Docs theme (sphinx_rtd_theme) is available, use it, but
otherwise gracefully fall back to the Sphinx default theme, with an
informative message to the user, and slightly less pretty HTML output.
Sphinx can now handle htmldocs, pdfdocs (if rst2pdf is available),
epubdocs and xmldocs targets. The output documents are written into per
output type subdirectories under Documentation/output.
Finally, you can pass options to sphinx-build using the SPHINXBUILD make
variable. For example, 'make SPHINXOPTS=-v htmldocs' for more verbose
output from Sphinx.
This is based on the original work by Jonathan Corbet, but he probably
wouldn't recognize this as his own anymore.
Signed-off-by: Jani Nikula <jani.nikula@intel.com>
2016-05-19 20:14:05 +08:00
|
|
|
#
|
|
|
|
# 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 = [
|
2016-07-15 18:42:08 +08:00
|
|
|
('kernel-documentation', u'Kernel', u'Kernel', u'J. Random Bozo'),
|
Documentation/sphinx: add basic working Sphinx configuration and build
Add basic configuration and makefile to build documentation from any
.rst files under Documentation using Sphinx. For starters, there's just
the placeholder index.rst.
At the top level Makefile, hook Sphinx documentation targets alongside
(but independent of) the DocBook toolchain, having both be run on the
various 'make *docs' targets.
All Sphinx processing is placed into Documentation/Makefile.sphinx. Both
that and the Documentation/DocBook/Makefile are now expected to handle
all the documentation targets, explicitly ignoring them if they're not
relevant for that particular toolchain. The changes to the existing
DocBook Makefile are kept minimal.
There is graceful handling of missing Sphinx and rst2pdf (which is
needed for pdf output) by checking for the tool and python module,
respectively, with informative messages to the user.
If the Read the Docs theme (sphinx_rtd_theme) is available, use it, but
otherwise gracefully fall back to the Sphinx default theme, with an
informative message to the user, and slightly less pretty HTML output.
Sphinx can now handle htmldocs, pdfdocs (if rst2pdf is available),
epubdocs and xmldocs targets. The output documents are written into per
output type subdirectories under Documentation/output.
Finally, you can pass options to sphinx-build using the SPHINXBUILD make
variable. For example, 'make SPHINXOPTS=-v htmldocs' for more verbose
output from Sphinx.
This is based on the original work by Jonathan Corbet, but he probably
wouldn't recognize this as his own anymore.
Signed-off-by: Jani Nikula <jani.nikula@intel.com>
2016-05-19 20:14:05 +08:00
|
|
|
]
|
2016-05-20 16:51:47 +08:00
|
|
|
|
|
|
|
# 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 = '..'
|
2016-08-13 22:12:42 +08:00
|
|
|
|
|
|
|
# ------------------------------------------------------------------------------
|
|
|
|
# Since loadConfig overwrites settings from the global namespace, it has to be
|
|
|
|
# the last statement in the conf.py file
|
|
|
|
# ------------------------------------------------------------------------------
|
|
|
|
loadConfig(globals())
|