rst2pdf README

rst2pdf.py is a PDF front-end for Docutils that is compatible with the rst2*.py front ends of the Docutils suite. It enables the generation of PDF documents from a reStructuredText source in one step cleaning up intermediate files.

rst2pdf.py is implemented as a combination of Docutils' rst2latex.py and rubber by Emmanuel Beffara.

Copyright: © 2008 Günter Milde

Licensed under the Apache License, Version 2.0 Provided WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND

Requirements

Docutils

for the reStructuredText -> LaTeX conversion

pdflatex and friends

A recent LaTeX installation including pdflatex.

rubber

Rubber is a program whose purpose is to handle all tasks related to the compilation of LaTeX documents. This includes compiling the document itself, of course, enough times so that all references are defined, and running BibTeX to manage bibliographic references. Automatic execution of dvips to produce PostScript documents is also included, as well as usage of pdfLaTeX to produce PDF documents.

Rubber packages exist for Debian, Gentoo, FreeBSD, NetBSD, Fink and Darwin.

The current development version contains many bug fixes: rubber snapshot

Installation

Copy the file rst2pdf.py into a directory in the operating system's PATH for executable binaries or create a link.

Usage

rst2pdf.py [options] [<source> [<destination>]]

Get a list of supported options with rst2pdf.py --help.

Configuration

rst2pdf.py uses the "latex" writer for conversion from reStructuredText which is configured in the [latex2e writer] section of the configuration files. (See Docutils Configuration)

Currently, the options for rubber are "hardcoded" in rst2pdf.py. Therfore, the configuration of the LaTeX -> PDF conversion requires changing the settings directly in the (well documented) rst2pdf.py file.

Troubleshooting

In case of errors, reproduce the document-generating steps by hand to localise the problem:

Send bug reports to the author or the docutils-users list.