diff mbox series

[1/1] doc: conf.py: correct title and author of generated pdf

Message ID 20241105021741.15615-1-heinrich.schuchardt@canonical.com
State New
Delegated to: Heinrich Schuchardt
Headers show
Series [1/1] doc: conf.py: correct title and author of generated pdf | expand

Commit Message

Heinrich Schuchardt Nov. 5, 2024, 2:17 a.m. UTC 
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 | 8 ++------
 1 file changed, 2 insertions(+), 6 deletions(-)
diff mbox series

Patch

diff --git a/doc/conf.py b/doc/conf.py
index ced3a6723fc..c50daf874a5 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -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