rinoh.frontend.sphinx is a Sphinx extension module. It provides a Sphinx
builder with the name rinoh. The builder recognizes the following
options. Of these, only
latex_documents) is required.
Determines which PDF documents to build. Its format is a list of dictionaries, one for each document to be generated. The supported keys for these dictionaries are listed below. Two of them are required:
- doc (required)
String that specifies the name of the master document (typically
- target (required)
The name of the target PDF file without the extension.
The following keys allow overriding the content included on the document’s title page and page headers/footers (depending on the template and its configuration). The values for text content can be plain text or
- logo (no default)
Path (absolute or relative to the location of the
conf.pyfile) to an image file, typically included on the title page.
- title (default: “
The title of the document.
- subtitle (default: “Release
Subtitle of the document.
- author (default: “
The document’s author.
- date (default: determined from
The document (build) date.
The remaining keys control what is included in the document and the document template (configuration) to use.
- toctree_only (default:
False. If true, the document itself is not included in the output, only the documents referenced by it via TOC trees.
- domain_indices (default:
- template (default:
Determines the template used to render the document. It takes:
rinoh_documents will also accept other keys than those listed above. These items will be available as document metadata and can be used in a custom document template.
rinoh_documents = [ dict(doc='index', target='manual', toctree_only=False, template='manual.rtt', logo='logo.pdf'), dict(doc='ref', target='reference', title='Reference Manual', template='reference.rtt', stamp='DRAFT'), ]
Limits rendering to the specified set of targets. This variable accepts either a list of strings or a string containing comma-separated values. The target names should match those set in
To render only the ‘manual’ target, you can set the following in
rinoh_targets = ['manual']
The same can be achieved from the command line using the by using the string form with
spinx-build -b rinoh -D rinoh_targets="manual" source build
Legacy Configuration Variables¶
The configuration variables below are no longer supported. Instead, their
functionality can now be configured per document in
This configuration variable is no longer supported since the document template can be specified in
This configuration variable is no longer supported since it is not obvious which style sheet will be used when the template configuration also specifies a style sheet. Please specify the style sheet to use in your template configuration file:
[TEMPLATE_CONFIGURATION] name = My Book template = book stylesheet = my_stylesheet.rts
This configuration variable is no longer supported since it was not obvious which paper size was being used when the template configuration (
rinoh_template) also specified a paper size. Please specify the paper_size to use in your template configuration file:
[TEMPLATE_CONFIGURATION] name = My Book template = book [VARIABLES] paper_size = A5
This configuration variable is no longer supported since the logo can be specified in the
This configuration variable is no longer supported since the domain_indices can be specified in the