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