1 # -*- coding: utf-8 -*-
3 # The Linux Kernel documentation build configuration file, created by
4 # sphinx-quickstart on Fri Feb 12 13:51:46 2016.
6 # This file is execfile()d with the current directory set to its
9 # Note that not all possible configuration values are present in this
12 # All configuration values have a default; values that are commented out
13 # serve to show the default.
23 def have_command(cmd):
24 """Search ``cmd`` in the ``PATH`` environment.
26 If found, return True.
27 If not found, return False.
29 return shutil.which(cmd) is not None
32 major, minor, patch = sphinx.version_info[:3]
35 # Warn about older versions that we don't want to support for much
38 if (major < 2) or (major == 2 and minor < 4):
39 print('WARNING: support for Sphinx < 2.4 will be removed soon.')
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.
44 sys.path.insert(0, os.path.abspath('sphinx'))
45 from load_config import loadConfig
47 # -- General configuration ------------------------------------------------
49 # If your documentation needs a minimal Sphinx version, state it here.
52 # Add any Sphinx extension module names here, as strings. They can be
53 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
55 extensions = ['kerneldoc', 'rstFlatTable', 'kernel_include',
56 'kfigure', 'sphinx.ext.ifconfig', 'automarkup',
57 'maintainers_include', 'sphinx.ext.autosectionlabel',
58 'kernel_abi', 'kernel_feat']
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
66 # GCC Compiler types not parsed by Sphinx:
69 # include/linux/compiler_types.h:
78 # include/linux/compiler_attributes.h:
85 "__attribute_const__",
95 "__no_caller_saved_registers",
109 # include/linux/memblock.h:
113 # include/linux/init.h:
117 # include/linux/linkage.h:
122 extensions.append('cdomain')
124 # Ensure that autosectionlabel will produce unique names
125 autosectionlabel_prefix_document = True
126 autosectionlabel_maxdepth = 2
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.
131 have_latex = have_command('latex')
132 have_dvipng = have_command('dvipng')
133 load_imgmath = have_latex and have_dvipng
135 # Respect SPHINX_IMGMATH (for html docs only)
136 if 'SPHINX_IMGMATH' in os.environ:
137 env_sphinx_imgmath = os.environ['SPHINX_IMGMATH']
138 if 'yes' in env_sphinx_imgmath:
140 elif 'no' in env_sphinx_imgmath:
143 sys.stderr.write("Unknown env SPHINX_IMGMATH=%s ignored.\n" % env_sphinx_imgmath)
145 # Always load imgmath for Sphinx <1.8 or for epub docs
146 load_imgmath = (load_imgmath or (major == 1 and minor < 8)
147 or 'epub' in sys.argv)
150 extensions.append("sphinx.ext.imgmath")
151 math_renderer = 'imgmath'
153 math_renderer = 'mathjax'
155 # Add any paths that contain templates here, relative to this directory.
156 templates_path = ['_templates']
158 # The suffix(es) of source filenames.
159 # You can specify multiple suffix as a list of string:
160 # source_suffix = ['.rst', '.md']
161 source_suffix = '.rst'
163 # The encoding of source files.
164 #source_encoding = 'utf-8-sig'
166 # The master toctree document.
169 # General information about the project.
170 project = 'The Linux Kernel'
171 copyright = 'The kernel development community'
172 author = 'The kernel development community'
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
178 # In a normal build, version and release are are set to KERNELVERSION and
179 # KERNELRELEASE, respectively, from the Makefile via Sphinx command line
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).
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)]
190 makefile_version = val
191 elif key == 'PATCHLEVEL':
192 makefile_patchlevel = val
193 if makefile_version and makefile_patchlevel:
198 if makefile_version and makefile_patchlevel:
199 version = release = makefile_version + '.' + makefile_patchlevel
201 version = release = "unknown version"
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.
208 def get_cline_version():
209 c_version = c_release = ''
211 if arg.startswith('version='):
213 elif arg.startswith('release='):
217 return c_version + '-' + c_release
219 return version # Whatever we came up with before
221 # The language for content autogenerated by Sphinx. Refer to documentation
222 # for a list of supported languages.
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.
228 # There are two options for replacing |today|: either, you set today to some
229 # non-false value, then it is used:
231 # Else, today_fmt is used as the format for a strftime call.
232 #today_fmt = '%B %d, %Y'
234 # List of patterns, relative to source directory, that match files and
235 # directories to ignore when looking for source files.
236 exclude_patterns = ['output']
238 # The reST default role (used for this markup: `text`) to use for all
242 # If true, '()' will be appended to :func: etc. cross-reference text.
243 #add_function_parentheses = True
245 # If true, the current module name will be prepended to all description
246 # unit titles (such as .. function::).
247 #add_module_names = True
249 # If true, sectionauthor and moduleauthor directives will be shown in the
250 # output. They are ignored by default.
251 #show_authors = False
253 # The name of the Pygments (syntax highlighting) style to use.
254 pygments_style = 'sphinx'
256 # A list of ignored prefixes for module index sorting.
257 #modindex_common_prefix = []
259 # If true, keep warnings as "system message" paragraphs in the built documents.
260 #keep_warnings = False
262 # If true, `todo` and `todoList` produce output, else they produce nothing.
263 todo_include_todos = False
266 highlight_language = 'none'
268 # -- Options for HTML output ----------------------------------------------
270 # The theme to use for HTML and HTML Help pages. See the documentation for
271 # a list of builtin themes.
274 html_theme = 'alabaster'
277 if "DOCS_THEME" in os.environ:
278 html_theme = os.environ["DOCS_THEME"]
280 if html_theme == 'sphinx_rtd_theme' or html_theme == 'sphinx_rtd_dark_mode':
281 # Read the Docs theme
283 import sphinx_rtd_theme
284 html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
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".
290 'theme_overrides.css',
293 # Read the Docs dark mode override theme
294 if html_theme == 'sphinx_rtd_dark_mode':
296 import sphinx_rtd_dark_mode
297 extensions.append('sphinx_rtd_dark_mode')
299 html_theme == 'sphinx_rtd_theme'
301 if html_theme == 'sphinx_rtd_theme':
302 # Add color-specific RTD normal mode
303 html_css_files.append('theme_rtd_colors.css')
305 html_theme_options = {
306 'navigation_depth': -1,
310 html_theme = 'alabaster'
312 if "DOCS_CSS" in os.environ:
313 css = os.environ["DOCS_CSS"].split(" ")
316 html_css_files.append(l)
318 if major <= 1 and minor < 8:
323 for l in html_css_files:
324 html_context['css_files'].append('_static/' + l)
326 if 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',
335 sys.stderr.write("Using %s theme\n" % html_theme)
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".
340 html_static_path = ['sphinx-static']
342 # If true, SmartyPants will be used to convert quotes and dashes to
343 # typographically correct entities.
344 html_use_smartypants = False
346 # Custom sidebar templates, maps document names to template names.
347 # Note that the RTD theme ignores this
348 html_sidebars = { '**': ['searchbox.html', 'localtoc.html', 'sourcelink.html']}
350 # about.html is available for alabaster theme. Add it at the front.
351 if html_theme == 'alabaster':
352 html_sidebars['**'].insert(0, 'about.html')
354 # Output file base name for HTML help builder.
355 htmlhelp_basename = 'TheLinuxKerneldoc'
357 # -- Options for LaTeX output ---------------------------------------------
360 # The paper size ('letterpaper' or 'a4paper').
361 'papersize': 'a4paper',
363 # The font size ('10pt', '11pt' or '12pt').
366 # Latex figure (float) alignment
367 #'figure_align': 'htbp',
369 # Don't mangle with UTF-8 chars
373 # Set document margins
375 hmargin=0.5in, vmargin=1in,
376 parsedliteralwraps=true,
377 verbatimhintsturnover=false,
380 # For CJK One-half spacing, need to be in front of hyperref
381 'extrapackages': r'\usepackage{setspace}',
383 # Additional stuff for the LaTeX 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}
393 # Fix reference escape troubles with Sphinx 1.4.x
395 latex_elements['preamble'] += '\\renewcommand*{\\DUrole}[2]{ #2 }\n'
398 # Load kerneldoc specific LaTeX settings
399 latex_elements['preamble'] += '''
400 % Load kerneldoc specific LaTeX settings
401 \\input{kerneldoc-preamble.sty}
404 # With Sphinx 1.6, it is possible to change the Bg color directly
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}
411 # However, it require to use sphinx heavy box with:
413 # \renewenvironment{sphinxlightbox} {%
414 # \\begin{sphinxheavybox}
416 # \\end{sphinxheavybox}
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.
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
430 # Add all other index files from Documentation/ subdirectories
431 for fn in os.listdir('.'):
432 doc = os.path.join(fn, "index")
433 if os.path.exists(doc + ".rst"):
435 for l in latex_documents:
440 latex_documents.append((doc, fn + '.tex',
441 'Linux %s Documentation' % fn.capitalize(),
442 'The kernel development community',
445 # The name of an image file (relative to this directory) to place at the top of
449 # For "manual" documents, if this is true, then toplevel headings are parts,
451 #latex_use_parts = False
453 # If true, show page references after internal links.
454 #latex_show_pagerefs = False
456 # If true, show URL addresses after external links.
457 #latex_show_urls = False
459 # Documents to append as an appendix to all manuals.
460 #latex_appendices = []
462 # If false, no module index is generated.
463 #latex_domain_indices = True
465 # Additional LaTeX stuff to be copied to build directory
466 latex_additional_files = [
467 'sphinx/kerneldoc-preamble.sty',
471 # -- Options for manual page output ---------------------------------------
473 # One entry per manual page. List of tuples
474 # (source start file, name, description, authors, manual section).
476 (master_doc, 'thelinuxkernel', 'The Linux Kernel Documentation',
480 # If true, show URL addresses after external links.
481 #man_show_urls = False
484 # -- Options for Texinfo output -------------------------------------------
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)
489 texinfo_documents = [
490 (master_doc, 'TheLinuxKernel', 'The Linux Kernel Documentation',
491 author, 'TheLinuxKernel', 'One line description of project.',
495 # -- Options for Epub output ----------------------------------------------
497 # Bibliographic Dublin Core info.
500 epub_publisher = author
501 epub_copyright = copyright
503 # A list of files that should not be packed into the epub file.
504 epub_exclude_files = ['search.html']
509 # Grouping the document tree into PDF files. List of tuples
510 # (source start file, target name, title, author, options).
512 # See the Sphinx chapter of https://ralsina.me/static/manual.pdf
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.
518 ('kernel-documentation', u'Kernel', u'Kernel', u'J. Random Bozo'),
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
524 kerneldoc_bin = '../scripts/kernel-doc'
525 kerneldoc_srctree = '..'
527 # ------------------------------------------------------------------------------
528 # Since loadConfig overwrites settings from the global namespace, it has to be
529 # the last statement in the conf.py file
530 # ------------------------------------------------------------------------------
531 loadConfig(globals())