doc/conf.py

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