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