1 # -*- coding: utf-8 -*-
3 # The U-Boot 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.
19 from subprocess import check_output
22 major, minor, patch = sphinx.version_info[:3]
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
31 # -- General configuration ------------------------------------------------
33 # If your documentation needs a minimal Sphinx version, state it here.
34 needs_sphinx = '2.4.4'
36 # Add any Sphinx extension module names here, as strings. They can be
37 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
39 extensions = ['kerneldoc', 'rstFlatTable', 'kernel_include',
40 'kfigure', 'sphinx.ext.ifconfig', # 'automarkup',
41 'maintainers_include', 'sphinx.ext.autosectionlabel',
42 'kernel_abi', 'kernel_feat']
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.
50 if (major > 3) or (minor > 0 or patch >= 2):
51 # Sphinx c function parser is more pedantic with regards to type
52 # checking. Due to that, having macros at c:function cause problems.
53 # Those needed to be scaped by using c_id_attributes[] array
55 # GCC Compiler types not parsed by Sphinx:
58 # include/linux/compiler_types.h:
67 # include/linux/compiler_attributes.h:
74 "__attribute_const__",
84 "__no_caller_saved_registers",
100 # include/efi_loader.h
103 # include/linux/memblock.h:
107 # include/linux/init.h:
111 # include/linux/linkage.h:
116 extensions.append('cdomain')
118 # Ensure that autosectionlabel will produce unique names
119 autosectionlabel_prefix_document = True
120 autosectionlabel_maxdepth = 2
122 extensions.append("sphinx.ext.imgmath")
124 # Add any paths that contain templates here, relative to this directory.
125 templates_path = ['_templates']
127 # The suffix(es) of source filenames.
128 # You can specify multiple suffix as a list of string:
129 # source_suffix = ['.rst', '.md']
130 source_suffix = '.rst'
132 # The encoding of source files.
133 #source_encoding = 'utf-8-sig'
135 # The master toctree document.
138 # General information about the project.
139 project = 'Das U-Boot'
140 copyright = 'The U-Boot development community'
141 author = 'The U-Boot development community'
143 # The version info for the project you're documenting, acts as replacement for
144 # |version| and |release|, also used in various other places throughout the
147 # In a normal build, version and release are are set to KERNELVERSION and
148 # KERNELRELEASE, respectively, from the Makefile via Sphinx command line
151 # The following code tries to extract the information by reading the Makefile,
152 # when Sphinx is run directly (e.g. by Read the Docs).
154 makefile_version = None
155 makefile_patchlevel = None
156 for line in open('../Makefile'):
157 key, val = [x.strip() for x in line.split('=', 2)]
159 makefile_version = val
160 elif key == 'PATCHLEVEL':
161 makefile_patchlevel = val
162 if makefile_version and makefile_patchlevel:
167 if makefile_version and makefile_patchlevel:
168 version = release = makefile_version + '.' + makefile_patchlevel
170 version = release = "unknown version"
172 # The language for content autogenerated by Sphinx. Refer to documentation
173 # for a list of supported languages.
175 # This is also used if you do content translation via gettext catalogs.
176 # Usually you set "language" from the command line for these cases.
179 # There are two options for replacing |today|: either, you set today to some
180 # non-false value, then it is used:
182 # Else, today_fmt is used as the format for a strftime call.
183 #today_fmt = '%B %d, %Y'
185 # List of patterns, relative to source directory, that match files and
186 # directories to ignore when looking for source files.
187 exclude_patterns = ['output']
189 # The reST default role (used for this markup: `text`) to use for all
193 # If true, '()' will be appended to :func: etc. cross-reference text.
194 #add_function_parentheses = True
196 # If true, the current module name will be prepended to all description
197 # unit titles (such as .. function::).
198 #add_module_names = True
200 # If true, sectionauthor and moduleauthor directives will be shown in the
201 # output. They are ignored by default.
202 #show_authors = False
204 # The name of the Pygments (syntax highlighting) style to use.
205 pygments_style = 'sphinx'
207 # A list of ignored prefixes for module index sorting.
208 #modindex_common_prefix = []
210 # If true, keep warnings as "system message" paragraphs in the built documents.
211 #keep_warnings = False
213 # If true, `todo` and `todoList` produce output, else they produce nothing.
214 todo_include_todos = False
217 highlight_language = 'none'
219 # -- Options for HTML output ----------------------------------------------
221 # The theme to use for HTML and HTML Help pages. See the documentation for
222 # a list of builtin themes.
224 # The Read the Docs theme is available from
225 # - https://github.com/snide/sphinx_rtd_theme
226 # - https://pypi.python.org/pypi/sphinx_rtd_theme
227 # - python-sphinx-rtd-theme package (on Debian)
229 import sphinx_rtd_theme
230 html_theme = 'sphinx_rtd_theme'
231 html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
233 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')
235 # Theme options are theme-specific and customize the look and feel of a theme
236 # further. For a list of options available for each theme, see the
238 #html_theme_options = {}
240 # Add any paths that contain custom themes here, relative to this directory.
241 #html_theme_path = []
243 # The name for this set of Sphinx documents. If None, it defaults to
244 # "<project> v<release> documentation".
247 # A shorter title for the navigation bar. Default is the same as html_title.
248 #html_short_title = None
250 # The name of an image file (relative to this directory) to place at the top
252 html_logo = '../tools/logos/u-boot_logo.svg'
254 # The name of an image file (within the static path) to use as favicon of the
255 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
259 # Add any paths that contain custom static files (such as style sheets) here,
260 # relative to this directory. They are copied after the builtin static files,
261 # so a file named "default.css" will overwrite the builtin "default.css".
263 html_static_path = ['sphinx-static']
267 '_static/theme_overrides.css',
271 # Add any extra paths that contain custom files (such as robots.txt or
272 # .htaccess) here, relative to this directory. These files are copied
273 # directly to the root of the documentation.
274 #html_extra_path = []
276 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
277 # using the given strftime format.
278 #html_last_updated_fmt = '%b %d, %Y'
280 # If true, SmartyPants will be used to convert quotes and dashes to
281 # typographically correct entities.
282 html_use_smartypants = False
284 # Custom sidebar templates, maps document names to template names.
287 # Additional templates that should be rendered to pages, maps page names to
289 #html_additional_pages = {}
291 # If false, no module index is generated.
292 #html_domain_indices = True
294 # If false, no index is generated.
295 #html_use_index = True
297 # If true, the index is split into individual pages for each letter.
298 #html_split_index = False
300 # If true, links to the reST sources are added to the pages.
301 #html_show_sourcelink = True
303 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
304 #html_show_sphinx = True
306 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
307 #html_show_copyright = True
309 # If true, an OpenSearch description file will be output, and all pages will
310 # contain a <link> tag referring to it. The value of this option must be the
311 # base URL from which the finished HTML is served.
312 #html_use_opensearch = ''
314 # This is the file name suffix for HTML files (e.g. ".xhtml").
315 #html_file_suffix = None
317 # Language to be used for generating the HTML full-text search index.
318 # Sphinx supports the following languages:
319 # 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja'
320 # 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr'
321 #html_search_language = 'en'
323 # A dictionary with options for the search language support, empty by default.
324 # Now only 'ja' uses this config value
325 #html_search_options = {'type': 'default'}
327 # The name of a javascript file (relative to the configuration directory) that
328 # implements a search results scorer. If empty, the default will be used.
329 #html_search_scorer = 'scorer.js'
331 # Output file base name for HTML help builder.
332 htmlhelp_basename = 'TheUBootdoc'
334 # -- Options for LaTeX output ---------------------------------------------
337 # The paper size ('letterpaper' or 'a4paper').
338 'papersize': 'a4paper',
340 # The font size ('10pt', '11pt' or '12pt').
343 # Latex figure (float) alignment
344 #'figure_align': 'htbp',
346 # Don't mangle with UTF-8 chars
350 # Set document margins
352 hmargin=0.5in, vmargin=1in,
353 parsedliteralwraps=true,
354 verbatimhintsturnover=false,
357 # Additional stuff for the LaTeX preamble.
359 % Use some font with UTF-8 support with XeLaTeX
360 \\usepackage{fontspec}
361 \\setsansfont{DejaVu Sans}
362 \\setromanfont{DejaVu Serif}
363 \\setmonofont{DejaVu Sans Mono}
367 # At least one book (translations) may have Asian characters
368 # with are only displayed if xeCJK is used
370 cjk_cmd = check_output(['fc-list', '--format="%{family[0]}\n"']).decode('utf-8', 'ignore')
371 if cjk_cmd.find("Noto Sans CJK SC") >= 0:
372 print ("enabling CJK for LaTeX builder")
373 latex_elements['preamble'] += '''
374 % This is needed for translations
376 \\setCJKmainfont{Noto Sans CJK SC}
379 # With Sphinx 1.6, it is possible to change the Bg color directly
381 # \definecolor{sphinxnoteBgColor}{RGB}{204,255,255}
382 # \definecolor{sphinxwarningBgColor}{RGB}{255,204,204}
383 # \definecolor{sphinxattentionBgColor}{RGB}{255,255,204}
384 # \definecolor{sphinximportantBgColor}{RGB}{192,255,204}
386 # However, it require to use sphinx heavy box with:
388 # \renewenvironment{sphinxlightbox} {%
389 # \\begin{sphinxheavybox}
391 # \\end{sphinxheavybox}
394 # Unfortunately, the implementation is buggy: if a note is inside a
395 # table, it isn't displayed well. So, for now, let's use boring
396 # black and white notes.
398 # Grouping the document tree into LaTeX files. List of tuples
399 # (source start file, target name, title,
400 # author, documentclass [howto, manual, or own class]).
401 # Sorted in alphabetical order
403 ('index', 'u-boot-hacker-manual.tex', 'U-Boot Hacker Manual',
404 'The U-Boot development community', 'manual'),
407 # Add all other index files from Documentation/ subdirectories
408 for fn in os.listdir('.'):
409 doc = os.path.join(fn, "index")
410 if os.path.exists(doc + ".rst"):
412 for l in latex_documents:
417 latex_documents.append((doc, fn + '.tex',
418 'U-Boot %s Documentation' % fn.capitalize(),
419 'The U-Boot development community',
422 # The name of an image file (relative to this directory) to place at the top of
426 # For "manual" documents, if this is true, then toplevel headings are parts,
428 #latex_use_parts = False
430 # If true, show page references after internal links.
431 #latex_show_pagerefs = False
433 # If true, show URL addresses after external links.
434 #latex_show_urls = False
436 # Documents to append as an appendix to all manuals.
437 #latex_appendices = []
439 # If false, no module index is generated.
440 #latex_domain_indices = True
443 # -- Options for manual page output ---------------------------------------
445 # One entry per manual page. List of tuples
446 # (source start file, name, description, authors, manual section).
448 (master_doc, 'u-boot', 'The U-Boot Documentation',
452 # If true, show URL addresses after external links.
453 #man_show_urls = False
456 # -- Options for Texinfo output -------------------------------------------
458 # Grouping the document tree into Texinfo files. List of tuples
459 # (source start file, target name, title, author,
460 # dir menu entry, description, category)
461 texinfo_documents = [
462 (master_doc, 'u-boot', 'The U-Boot Documentation',
463 author, 'U-Boot', 'Boot loader for embedded systems',
467 # Documents to append as an appendix to all manuals.
468 #texinfo_appendices = []
470 # If false, no module index is generated.
471 #texinfo_domain_indices = True
473 # How to display URL addresses: 'footnote', 'no', or 'inline'.
474 #texinfo_show_urls = 'footnote'
476 # If true, do not generate a @detailmenu in the "Top" node's menu.
477 #texinfo_no_detailmenu = False
480 # -- Options for Epub output ----------------------------------------------
482 # Bibliographic Dublin Core info.
485 epub_publisher = author
486 epub_copyright = copyright
488 # The basename for the epub file. It defaults to the project name.
489 #epub_basename = project
491 # The HTML theme for the epub output. Since the default themes are not
492 # optimized for small screen space, using the same theme for HTML and epub
493 # output is usually not wise. This defaults to 'epub', a theme designed to save
497 # The language of the text. It defaults to the language option
498 # or 'en' if the language is not set.
501 # The scheme of the identifier. Typical schemes are ISBN or URL.
504 # The unique identifier of the text. This can be a ISBN number
505 # or the project homepage.
506 #epub_identifier = ''
508 # A unique identification for the text.
511 # A tuple containing the cover image and cover page html template filenames.
514 # A sequence of (type, uri, title) tuples for the guide element of content.opf.
517 # HTML files that should be inserted before the pages created by sphinx.
518 # The format is a list of tuples containing the path and title.
521 # HTML files that should be inserted after the pages created by sphinx.
522 # The format is a list of tuples containing the path and title.
523 #epub_post_files = []
525 # A list of files that should not be packed into the epub file.
526 epub_exclude_files = ['search.html']
528 # The depth of the table of contents in toc.ncx.
531 # Allow duplicate toc entries.
534 # Choose between 'default' and 'includehidden'.
535 #epub_tocscope = 'default'
537 # Fix unsupported image types using the Pillow.
538 #epub_fix_images = False
540 # Scale large images.
541 #epub_max_image_width = 0
543 # How to display URL addresses: 'footnote', 'no', or 'inline'.
544 #epub_show_urls = 'inline'
546 # If false, no index is generated.
547 #epub_use_index = True
552 # Grouping the document tree into PDF files. List of tuples
553 # (source start file, target name, title, author, options).
555 # See the Sphinx chapter of https://ralsina.me/static/manual.pdf
557 # FIXME: Do not add the index file here; the result will be too big. Adding
558 # multiple PDF files here actually tries to get the cross-referencing right
559 # *between* PDF files.
561 ('uboot-documentation', u'U-Boot', u'U-Boot', u'J. Random Bozo'),
564 # kernel-doc extension configuration for running Sphinx directly (e.g. by Read
565 # the Docs). In a normal build, these are supplied from the Makefile via command
567 kerneldoc_bin = '../scripts/kernel-doc'
568 kerneldoc_srctree = '..'
570 # ------------------------------------------------------------------------------
571 # Since loadConfig overwrites settings from the global namespace, it has to be
572 # the last statement in the conf.py file
573 # ------------------------------------------------------------------------------
574 loadConfig(globals())