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