rst2pdf

The usual way of creating PDF from reStructuredText is by going through LaTeX. rst2pdf provides an alternative by producing PDF directly using the ReportLab library.

Installation:

Download it from this site, then

install manually

python setup.py install

or try the egg with the provided buildout:

python bootstrap.py
bin/buildout

you'll get a rst2pdf executable in the bin directory

or get it via PyPI:

easy_install rst2pdf

Features:

• User-defined page layout. Multiple frames per page, multiple layouts per document.
• Cascading stylesheet mechanism, define only what you want changed.
• Supports TTF and Type1 font embedding.
• Any number of paragraph styles using the class directive.
• Any number of character styles using text roles.
• Custom page sizes and margins.
• Syntax highlighter for many languages, using Pygments.
• Supports embedding almost any kind of raster or vector images.
• Fast
• Supports hyphenation (using wordaxe).
• Full user's manual (PDF version)

What is new in this release:

• Many bugs were fixed.

What is new in version 0.14:

• Fixed Issue 197 : Table borders were confusing.
• Fixed Issue 297 : styles from default.json leaked onto other syntax highlighting stylesheets.
• Fixed Issue 295 : keyword replacement in headers/footers didn't work if Page and others was inside a table.
• New feature: oddeven directive to display alternative content on odd/even pages (good for headers/footers!)
• Switched all stylesheets to more readable RSON format.
• Fixed Issue 294 : Images were deformed when only height was specified.
• Fixed Issue 293 : Accept left/center/right as alignments in stylesheets.
• Fixed Issue 292 : separate style for line numbers in codeblocks
• Fixed Issue 291 : support class directive for codeblocks
• Fixed Issue 104 : total number of pages in header/footer works in all cases now.
• Fixed Issue 168 : linenos and linenothreshold options in Sphinx now work correctly.
• Fixed regression in 0.12 (interaction between rst2pdf and sphinx math)
• Documented extensions in the manual
• Better styling of bullets/items ( Issue 289 )
• Fixed Issue 290 : don't fail on broken images
• Better font finding in windows (patch by techtonik, Issue 282 ).
• Fixed Issue 166 : Implemented Sphinx's hlist (horizontal lists)
• Fixed Issue 284 : Implemented production lists for sphinx
• Fixed Issue 165 : Definition lists not properly indented inside admonitions or tables.
• SVG Images work inline when using the inkscape extension.
• Fixed Issue 268 : TOCs shifted to the left on RL 2.4
• Fixed Issue 281 : sphinx test automation was broken
• Fixed Issue 280 : wrong page templates used in sphinx

What is new in version 0.12.2:

• Fix Issue 219 (incompatibility with reportlab 2.1)
• Added pdf_default_dpi option for pdfbuilder
• More style docs in the manual
• Better styling of lists
• Fix bug reported in comments in my blog where a stylesheet with showHeader=True and no explicit header caused an exception.
• Fixed Issue 215: crashes in bookrest's background renderer.

What is new in version 0.12.1:

• Fixed Issue 202: broken processing of HTML raw nodes
• New "options" section in stylesheets. New ["options"]["stylesheets"]
• subsection, which works similar to -s or to an include file: a list of stylesheets
• to be processed before the current one.
• New --config option
• Fix for Issue 200 (position of frames was miscalculated)
• Fix For Issue 188 (uniconvertor "'unicode' object has no attribute
• 'readline'" error)
• New raw directive command: SetPageCounter. This enables page counter manipulation, and use of different styles, roman, lowerroman, alpha, loweralpha and arabic.
• New raw directive commands: EvenPageBreak and OddPageBreak
• New option to make sections break to odd or even pages: --break-side=VALUE
• New option to add an empty page at the beginning of the document: --blank-first-page.
• Fixed bug in authors field width calculation
• Support % in bullet and field lists column widths
• Use bullet_list or item_list styles for bullet and item lists
• respectively.
• Support % in field list column width description.
• Fix for Issue 184 (font metrics go crazy with TT font)
• New admonition code based on SplitTable (beta quality)
• Fix for Issue 180 (support for very very long list items. Needs
• testing)
• Fix for Issue 175 (widow/orphan titles)
• Fix for Issue 174 (line blocks didn't respect indentation)
• Worked around Issue 173 (quotes didn't indent inside table cells)
• Respect spaceBefore and spaceAfter for footnotes/endnotes
• Added tests for (almost) all of sphinx's custom markup
• Fixed Issue 170 (Wrong font embedding)
• Fixed Issue 171 (Damaged xref table)
• Fixed Issue 159 (Admonition and table widths were miscalculated)
• Fixed Issue 162 (wrong highlighting using sphinx)
• Changed default language policy as described in Issue 53
• Fixed Issue 148 (Images should be looked for relative to source
• document)
• Fixed Issue 158 (Some admonitions crashed pdfbuilder)
• Fixed Issue 154 (incompatibility with RL 2.1)
• Fixed Issue 155 (crash when sidebars split in a certain way)
• Fixed issue 152 (padding and alignment of table styles, like when using literal blocks inside lists)
• Integrated pdfbuilder sphinx extension (more work needed)
• Kerning support for true type fonts (thanks to wordaxe!), added to the docs, added convenience stylesheet.
• Fixed Issue 151 and behaviour on Issue 116, about images too large for available space / the full frame height.
• Fixed problem in admonition titles.
• Fixed section names in headers/footers: FIRST section on the page is used, not LAST.
• Fixed Issue 145: padding of literal blocks was broken.
• Fixed bug: paragraphs with ids should have the matching anchors
• Fixed bug: internal references were not linked correctly
• Fixed Issue 144: PDF TOC had wrong page numbers in some cases
• More sphinx compatibility
• New table styles code, also make class directive work for tables
• Fixed Issue 140: html-like markup in titles was kept in the PDF TOC
• Fixed Issue 138: Redid figure styling. Also fixed bugs in
• BoxedContainer
• Fixed Issue 137: bugs in escaping characters in interpreted roles
• Make it work (in a slightly degraded mode) without PIL, as long as you are only using JPGs or have PythonMagick installed. This is good for OS X, where "installing PIL is a PITA"
• Fixed issue 134: entities were replaced in interpreted roles (not needed)
• Support for aafigure (http://launchpad.net/aafigure)
• Spacers support units
• TOC styles now configurable in stylesheet

What is new in version 0.12:

• Fixed Issue 202: broken processing of HTML raw nodes
• New "options" section in stylesheets. New ["options"]["stylesheets"] subsection, which works similar to -s or to an include file: a list of stylesheets to be processed before the current one.
• New --config option
• Fix for Issue 200 (position of frames was miscalculated)
• Fix For Issue 188 (uniconvertor "'unicode' object has no attribute 'readline'" error)
• New raw directive command: SetPageCounter. This enables page counter manipulation, and use of different styles, roman, lowerroman, alpha, loweralpha and arabic.
• New raw directive commands: EvenPageBreak and OddPageBreak
• New option to make sections break to odd or even pages: --break-side=VALUE
• New option to add an empty page at the beginning of the document: --blank-first-page.
• Fixed bug in authors field width calculation
• Support % in bullet and field lists column widths
• Use bullet_list or item_list styles for bullet and item lists respectively.
• Support % in field list column width description.
• Fix for Issue 184 (font metrics go crazy with TT font)
• New admonition code based on SplitTable (beta quality)
• Fix for Issue 180 (support for very very long list items. Needs testing)
• Fix for Issue 175 (widow/orphan titles)
• Fix for Issue 174 (line blocks didn't respect indentation)
• Worked around Issue 173 (quotes didn't indent inside table cells)
• Respect spaceBefore and spaceAfter for footnotes/endnotes
• Added tests for (almost) all of sphinx's custom markup
• Fixed Issue 170 (Wrong font embedding)
• Fixed Issue 171 (Damaged xref table)
• Fixed Issue 159 (Admonition and table widths were miscalculated)
• Fixed Issue 162 (wrong highlighting using sphinx)
• Changed default language policy as described in Issue 53
• Fixed Issue 148 (Images should be looked for relative to source document)
• Fixed Issue 158 (Some admonitions crashed pdfbuilder)
• Fixed Issue 154 (incompatibility with RL 2.1)
• Fixed Issue 155 (crash when sidebars split in a certain way)
• Fixed issue 152 (padding and alignment of table styles, like when using literal blocks inside lists)
• Integrated pdfbuilder sphinx extension (more work needed)
• Kerning support for true type fonts (thanks to wordaxe!), added to the docs, added convenience stylesheet.
• Fixed Issue 151 and behaviour on Issue 116, about images too large for available space / the full frame height.
• Fixed problem in admonition titles.
• Fixed section names in headers/footers: FIRST section on the page is used, not LAST.
• Fixed Issue 145: padding of literal blocks was broken.
• Fixed bug: paragraphs with ids should have the matching anchors
• Fixed bug: internal references were not linked correctly
• Fixed Issue 144: PDF TOC had wrong page numbers in some cases
• More sphinx compatibility
• New table styles code, also make class directive work for tables
• Fixed Issue 140: html-like markup in titles was kept in the PDF TOC
• Fixed Issue 138: Redid figure styling. Also fixed bugs in BoxedContainer
• Fixed Issue 137: bugs in escaping characters in interpreted roles
• Make it work (in a slightly degraded mode) without PIL, as long as you are only using JPGs or have PythonMagick installed.
• This is good for OS X, where "installing PIL is a PITA"
• Fixed issue 134: entities were replaced in interpreted roles (not needed)
• Support for aafigure (http://launchpad.net/aafigure)
• Spacers support units
• TOC styles now configurable in stylesheet

What is new in version 0.11:

• Degrade more gracefully when one or more wordaxe hyphenators are broken (currently DWC is the broken one)
• Fixed issue 132: in some cases, with user-defined fontAlias, bold and italic would get confused (getting italic instead of bold in inline markup, for instance).
• New stylesheet no-compact-lists to make lists... less compact
• SVG images now handle % as a width unit correctly.
• Implemented issue 127: support images in PDF format. Right now they
• are rasterized, so it's not ideal. Perhaps something better will come up later.
• Fixed issue 129: make it work around a prblem with KeepTogether in RL 2.1 it probably makes the output look worse in some cases when using that.
• RL 2.1 is not really supported, so added a warning.
• Fixed issue 130: use os.pathsep instead of ":" since ":" in windows is used in disk names (and we still pay for DOS idiocy, in 2009)
• Fixed issue 128: headings level 3+ all looked the same
• Ugly bugfix for Issue 126: crashes when using images in header + TOC
• New tstyles section in the stylesheet provides more configurable list layouts and more powerful table styling.
• Better syntax highlighting (supports bold/italic)
• Workaround for issue 103 so you can use borderPadding as a list (but it will look wrong if you are using wordaxe

What is new in version 0.10:

• Issue 87: Table headers can be repeated in each page (thanks to Yasushi Masuda)
• Issue 93: Line number support for code blocks (:linenos: true)
• Issue 111: Added --no-footnote-backlinks option
• Issue 107: Support localized directives/roles (example: sommaire instead of contents)
• Issue 112: Fixed crash when processing empty list items
• Issue 98: Nobreak support, and set as default for inline-literals so they don't hyphenate.
• Slightly better tests
• Background colors in text styles work with reportlab 2.3
• Issue 99: Fixed hyphenation in headers/footers (requires wordaxe 0.3.2)
• Issue 106: Crash on demo.txt fixed (requires wordxe 0.3.2)
• Issue 102: Implemented styles for bulleted and numbered lists
• Issue 38: Default headers/footers via options, config file or stylesheet
• Issue 88: Implemented much better book-style TOCs
• Issue 100: Fixed bug with headers/footers and Reportlab 2.3
• Issue 95: Fixed bug with indented tables
• Issue 89: Implemented --version
• Issue 84: Fixed bug with relative include paths
• Issue 85: Fixed bug with table cell styles
• Issue 83: Fixed bug with numeric colors in backColor attribute
• Issue 44: Support for stdin and stdout
• Issue 79: Added --stylesheet-path option
• Issue 80: Send warnings to stderr, not stdout
• Issue 66: Implemented "smart quotes"
• Issue 77: Work around missing matplotlib
• Proper translation of labels (such as "Author", "Version" etc.) using the docutils languages package. (r473)
• Fixed problems with wrong or non-existing fonts. (r484)
• Page transition effect support for presentations (r423)

What is new in version 0.9:

• Math support via matplotlib (no TeX required)
• Huge bugs fixed
• Support lists that don' t start at 1
• Nicer definition lists