mirror of
https://github.com/u-boot/u-boot.git
synced 2025-04-30 08:07:59 +00:00
doc: Add reference to U-Boot project in conf.py
With the last update of conf.py the references to U-Boot where replaced by
references to Linux.
Fix the project references in the generated documentation.
Reported-by: Simon Glass <sjg@chromium.org>
Reported-by: Bin Meng <bmeng.cn@gmail.com>
Fixes: 98f01cf7a2
("doc: update Kernel documentation build system")
Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
This commit is contained in:
parent
e67beffee0
commit
611e7f860a
1 changed files with 13 additions and 11 deletions
24
doc/conf.py
24
doc/conf.py
|
@ -147,9 +147,9 @@ source_suffix = '.rst'
|
||||||
master_doc = 'index'
|
master_doc = 'index'
|
||||||
|
|
||||||
# General information about the project.
|
# General information about the project.
|
||||||
project = 'The Linux Kernel'
|
project = 'Das U-Boot'
|
||||||
copyright = 'The kernel development community'
|
copyright = 'The U-Boot development community'
|
||||||
author = 'The kernel development community'
|
author = 'The U-Boot development community'
|
||||||
|
|
||||||
# The version info for the project you're documenting, acts as replacement for
|
# The version info for the project you're documenting, acts as replacement for
|
||||||
# |version| and |release|, also used in various other places throughout the
|
# |version| and |release|, also used in various other places throughout the
|
||||||
|
@ -260,7 +260,7 @@ except ImportError:
|
||||||
|
|
||||||
# The name of an image file (relative to this directory) to place at the top
|
# The name of an image file (relative to this directory) to place at the top
|
||||||
# of the sidebar.
|
# of the sidebar.
|
||||||
#html_logo = None
|
html_logo = '../tools/logos/u-boot_logo.svg'
|
||||||
|
|
||||||
# The name of an image file (within the static path) to use as favicon of the
|
# The name of an image file (within the static path) to use as favicon of the
|
||||||
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
||||||
|
@ -340,7 +340,7 @@ html_use_smartypants = False
|
||||||
#html_search_scorer = 'scorer.js'
|
#html_search_scorer = 'scorer.js'
|
||||||
|
|
||||||
# Output file base name for HTML help builder.
|
# Output file base name for HTML help builder.
|
||||||
htmlhelp_basename = 'TheLinuxKerneldoc'
|
htmlhelp_basename = 'TheUBootdoc'
|
||||||
|
|
||||||
# -- Options for LaTeX output ---------------------------------------------
|
# -- Options for LaTeX output ---------------------------------------------
|
||||||
|
|
||||||
|
@ -470,6 +470,8 @@ if major == 1 and minor < 6:
|
||||||
# author, documentclass [howto, manual, or own class]).
|
# author, documentclass [howto, manual, or own class]).
|
||||||
# Sorted in alphabetical order
|
# Sorted in alphabetical order
|
||||||
latex_documents = [
|
latex_documents = [
|
||||||
|
('index', 'u-boot-hacker-manual.tex', 'U-Boot Hacker Manual',
|
||||||
|
'The U-Boot development community', 'manual'),
|
||||||
]
|
]
|
||||||
|
|
||||||
# Add all other index files from Documentation/ subdirectories
|
# Add all other index files from Documentation/ subdirectories
|
||||||
|
@ -483,8 +485,8 @@ for fn in os.listdir('.'):
|
||||||
break
|
break
|
||||||
if not has:
|
if not has:
|
||||||
latex_documents.append((doc, fn + '.tex',
|
latex_documents.append((doc, fn + '.tex',
|
||||||
'Linux %s Documentation' % fn.capitalize(),
|
'U-Boot %s Documentation' % fn.capitalize(),
|
||||||
'The kernel development community',
|
'The U-Boot development community',
|
||||||
'manual'))
|
'manual'))
|
||||||
|
|
||||||
# The name of an image file (relative to this directory) to place at the top of
|
# The name of an image file (relative to this directory) to place at the top of
|
||||||
|
@ -513,7 +515,7 @@ for fn in os.listdir('.'):
|
||||||
# One entry per manual page. List of tuples
|
# One entry per manual page. List of tuples
|
||||||
# (source start file, name, description, authors, manual section).
|
# (source start file, name, description, authors, manual section).
|
||||||
man_pages = [
|
man_pages = [
|
||||||
(master_doc, 'thelinuxkernel', 'The Linux Kernel Documentation',
|
(master_doc, 'dasuboot', 'The U-Boot Documentation',
|
||||||
[author], 1)
|
[author], 1)
|
||||||
]
|
]
|
||||||
|
|
||||||
|
@ -527,8 +529,8 @@ man_pages = [
|
||||||
# (source start file, target name, title, author,
|
# (source start file, target name, title, author,
|
||||||
# dir menu entry, description, category)
|
# dir menu entry, description, category)
|
||||||
texinfo_documents = [
|
texinfo_documents = [
|
||||||
(master_doc, 'TheLinuxKernel', 'The Linux Kernel Documentation',
|
(master_doc, 'DasUBoot', 'The U-Boot Documentation',
|
||||||
author, 'TheLinuxKernel', 'One line description of project.',
|
author, 'DasUBoot', 'One line description of project.',
|
||||||
'Miscellaneous'),
|
'Miscellaneous'),
|
||||||
]
|
]
|
||||||
|
|
||||||
|
@ -626,7 +628,7 @@ epub_exclude_files = ['search.html']
|
||||||
# multiple PDF files here actually tries to get the cross-referencing right
|
# multiple PDF files here actually tries to get the cross-referencing right
|
||||||
# *between* PDF files.
|
# *between* PDF files.
|
||||||
pdf_documents = [
|
pdf_documents = [
|
||||||
('kernel-documentation', u'Kernel', u'Kernel', u'J. Random Bozo'),
|
('uboot-documentation', u'U-Boot', u'U-Boot', u'J. Random Bozo'),
|
||||||
]
|
]
|
||||||
|
|
||||||
# kernel-doc extension configuration for running Sphinx directly (e.g. by Read
|
# kernel-doc extension configuration for running Sphinx directly (e.g. by Read
|
||||||
|
|
Loading…
Add table
Reference in a new issue