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