]> git.dujemihanovic.xyz Git - u-boot.git/commitdiff
doc: conf.py: correct title and author of generated pdf
authorHeinrich Schuchardt <heinrich.schuchardt@canonical.com>
Tue, 5 Nov 2024 02:17:41 +0000 (03:17 +0100)
committerHeinrich Schuchardt <heinrich.schuchardt@canonical.com>
Sat, 9 Nov 2024 08:56:46 +0000 (09:56 +0100)
Adjust the PDF output options for rst2pdf:

* Set start document to 'index'.
* Set title to 'Das U-Boot'.
* Set author to 'The U-Boot development community'.

Correct documentation link.

Remove obsolete FIXME.

Link: https://rst2pdf.org/static/manual.html
Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
doc/conf.py

index ced3a6723fc5ee5ed434516040fd55fd957cfa88..c50daf874a53d6720907b14ff63238f654f2b0bb 100644 (file)
@@ -560,13 +560,9 @@ epub_exclude_files = ['search.html']
 # Grouping the document tree into PDF files. List of tuples
 # (source start file, target name, title, author, options).
 #
-# See the Sphinx chapter of https://ralsina.me/static/manual.pdf
-#
-# FIXME: Do not add the index file here; the result will be too big. Adding
-# multiple PDF files here actually tries to get the cross-referencing right
-# *between* PDF files.
+# See https://rst2pdf.org/static/manual.html#sphinx
 pdf_documents = [
-    ('uboot-documentation', u'U-Boot', u'U-Boot', u'J. Random Bozo'),
+    ('index', u'U-Boot', u'Das U-Boot', u'The U-Boot development community'),
 ]
 
 # kernel-doc extension configuration for running Sphinx directly (e.g. by Read