Repository files navigation

The usual way of creating PDF from reStructuredText is by going through LaTeX.This tool provides an alternative by producing PDF directly using the ReportLablibrary.

More information is available at themain website.

• User-defined page layout. Multiple frames per page, multiple layouts perdocument.
• Page transitions
• 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.
• Supports hyphenation.
• Sphinx integration
• Full user's manual

rst2pdf supports Python 3.9 or greater. Version 0.102 was the last version to support Python 3.8. Version 0.99 wasthe last version to support Python 3.6 & 3.7, with 0.97 the last version to support Python 2.7.

The latest released version may be installed from PyPI by usingpipx:

$ pipx install rst2pdf

rst2pdf also has support for a number of features that require additional dependencies. Installation of all therequired dependencies usingpipx may be installed using:

$ pipx install rst2pdf[aafiguresupport,mathsupport,plantumlsupport,rawhtmlsupport,sphinx,svgsupport]

As withpipx above, the latest released version may be installed from PyPI by usinguv:

$ uv tool install rst2pdf

If you don't haveuv, please seethe installation docs

Installation of all the required dependencies usinguv may be installed using:

$ uv tool install rst2pdf[aafiguresupport,mathsupport,plantumlsupport,rawhtmlsupport,sphinx,svgsupport]

If you are using a system that supportssnapsthen you can install from there with:

$ snap install rst2pdf

Work on rst2pdf has restarted on GitHub, with the goals of adding newfeatures, addressing outstanding issues, and not breaking anything. Youcan clone the repository and install this version:

$ git clone https://github.com/rst2pdf/rst2pdf$ cd rst2pdf$ git checkout <desired-branch> # if you want something other than main$ uv tool install .[aafiguresupport,mathsupport,plantumlsupport,rawhtmlsupport,sphinx,svgsupport]

If you intend to work on rst2pdf's source code, seedoc/DEVELOPERS.rst.

To convert a reStructuredText document to a PDF, simply run:

$ rst2pdf <document name> output.pdf

For information on available options, use-h:

$ rst2pdf -h

To enable basic integration with Sphinx, modify yourconf.py file to enabletherst2pdf.pdfbuilder extension and configure thepdf_documentsoption. For example:

extensions = [    # ...    'rst2pdf.pdfbuilder',]# Grouping the document tree into PDF files. List of tuples# (source start file, target name, title, author, options).pdf_documents = [    ('index', 'MyProject', 'My Project', 'Author Name'),]

For information on thepdf_documents option and the many other optionsavailable, refer to themanual.

SeeCONTRIBUTING.

rst2pdf is an inclusive and welcoming community. To participate in this project, everyone is bound by ourCommunity Code of Conduct.