Add config option to change default subtitle prefix

doc/manual.rst

@@ -2016,6 +2016,9 @@ To use it in your existing Sphinx project you need to do the following:
     # Name of the cover page template to use
     # pdf_cover_template = 'sphinxcover.tmpl'
 
+    # Label to use as a prefix for the subtitle on the cover page
+    # subtitle_prefix = 'version'
+
     # Documents to append as an appendix to all manuals.
     # pdf_appendices = []
 

rst2pdf/pdfbuilder.py

@@ -680,7 +680,7 @@ def add_template_path(path):
             # Feed data to the template, get restructured text.
             cover_text = template.render(
                 title=self.document.settings.title or visitor.elements['title'],
-                subtitle='%s %s' % (_('version'), self.config.version),
+                subtitle='%s %s' % (self.config.subtitle_prefix, self.config.version),
                 authors=authors,
                 date=date,
             )
@@ -991,6 +991,7 @@ def setup(app):
     app.add_config_value(
         'pdf_baseurl', urlunparse(['file', os.getcwd() + os.sep, '', '', '', '']), None
     )
+    app.add_config_value('subtitle_prefix', 'version', None)
 
     project_doc = app.config.project + ' Documentation'
     app.config.pdf_documents.append(

tests/input/sphinx-subtitle-prefix/conf.py

@@ -0,0 +1,130 @@
+# -*- coding: utf-8 -*-
+
+# -- General configuration -----------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = ['rst2pdf.pdfbuilder']
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'sphinxsubtitle'
+copyright = u'2023, rst2pdf project'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '1.1'
+# The full version, including alpha/beta/rc tags.
+release = '1.0-test-release'
+
+
+# -- Options for PDF output --------------------------------------------------
+
+# Grouping the document tree into PDF files. List of tuples
+# (source start file, target name, title, author, options).
+#
+# If there is more than one author, separate them with \\.
+# For example: r'Guido van Rossum\\Fred L. Drake, Jr., editor'
+#
+# The options element is a dictionary that lets you override
+# this config per-document. For example:
+#
+# ('index', 'MyProject', 'My Project', 'Author Name', {'pdf_compressed': True})
+#
+# would mean that specific document would be compressed
+# regardless of the global 'pdf_compressed' setting.
+
+pdf_documents = [
+    ('index', 'MyProject', 'My Project', 'Author Name'),
+]
+
+# A comma-separated list of custom stylesheets. Example:
+pdf_stylesheets = ['sphinx', 'a4']
+
+# A list of folders to search for stylesheets. Example:
+#pdf_style_path = ['.', '_styles']
+
+# Create a compressed PDF
+# Use True/False or 1/0
+# Example: compressed=True
+# pdf_compressed = False
+
+# A colon-separated list of folders to search for fonts. Example:
+# pdf_font_path = ['/usr/share/fonts', '/usr/share/texmf-dist/fonts/']
+
+# Language to be used for hyphenation support
+# pdf_language = "en_US"
+
+# Mode for literal blocks wider than the frame. Can be
+# overflow, shrink or truncate
+# pdf_fit_mode = "shrink"
+
+# Section level that forces a break page.
+# For example: 1 means top-level sections start in a new page
+# 0 means disabled
+# pdf_break_level = 0
+
+# When a section starts in a new page, force it to be 'even', 'odd',
+# or just use 'any'
+# pdf_breakside = 'any'
+
+# Insert footnotes where they are defined instead of
+# at the end.
+# pdf_inline_footnotes = True
+
+# verbosity level. 0 1 or 2
+# pdf_verbosity = 0
+
+# If false, no index is generated.
+# pdf_use_index = True
+
+# If false, no modindex is generated.
+# pdf_use_modindex = True
+
+# If false, no coverpage is generated.
+# pdf_use_coverpage = True
+
+# Name of the cover page template to use
+# pdf_cover_template = 'sphinxcover.tmpl'
+
+# Label to use as a prefix for the subtitle on the cover page
+subtitle_prefix = 'Subtle Subtitle Prefix'
+
+# Documents to append as an appendix to all manuals.
+# pdf_appendices = []
+
+# Enable experimental feature to split table cells. Use it
+# if you get "DelayedTable too big" errors
+# pdf_splittables = False
+
+# Set the default DPI for images
+# pdf_default_dpi = 72
+
+# Enable rst2pdf extension modules
+# pdf_extensions = []
+
+# Page template name for "regular" pages
+# pdf_page_template = 'cutePage'
+
+# Show Table Of Contents at the beginning?
+# pdf_use_toc = True
+
+# How many levels deep should the table of contents be?
+pdf_toc_depth = 9999
+
+# Add section number to section references
+pdf_use_numbered_links = False
+
+# Background images fitting mode
+pdf_fit_background_mode = 'scale'
+
+# Repeat table header on tables that cross a page boundary?
+pdf_repeat_table_rows = True
+
+# Enable smart quotes (1, 2 or 3) or disable by setting to 0
+pdf_smartquotes = 0

tests/input/sphinx-subtitle-prefix/index.rst

@@ -0,0 +1,4 @@
+Sphinx subtitle prefix test
+###########################
+
+This document exists to test subtitles on the cover page.