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