rinohtype: The Python Document Processor

Release v0.5.0. (Release History)

rinohtype is a Python library that transforms a structured document into a professionally typeset PDF guided by a document template and style sheet. It can be used to create any kind of document, but its focus is on complex documents such as technical manuals.

Included with rinohtype is the rinoh command line tool that renders reStructuredText and Markdown (CommonMark) documents. Support for DITA is available in the commercially supported Pro version.

rinohtype also includes support for Sphinx, which helps writing large structured documents and supports a multitude of different output formats including searchable HTML. rinohtype adds support to produce PDF output.

Here is a list of rinohtype’s main features:

• a powerful page layout system supporting columns, running headers/footers, floatable elements and footnotes

• figures, large tables and automatically generated table of contents

• automatic numbering and cross-referencing of sections, figures and tables

• use one of the highly configurable included document templates or create your own custom template

• the intuitive style sheets make it easy to change the style of individual document elements

• modular design allowing for multiple frontends (such as reStructuredText, Markdown, DocBook, …) and backends (PDF, SVG, bitmap, …)

• handles OpenType, TrueType and Type1 fonts with support for advanced typographic features such as kerning, ligatures and small capitals

• embeds PDF, PNG and JPEG images, preserving transparency and color profiles

• easy to deploy; pure-Python with few dependencies

• built on Unicode; ready for non-latin languages

rinohtype is currently in a beta phase. We are working toward a first stable release.

rinohtype is open source software licensed under the GNU AGPL 3.0. Practically, this means you are free to use it in open-source software, but not in (commercial) closed-source software. For the latter, you need to obtain a commercial license. We are also available for consultancy projects involving rinohtype, so don’t hesitate to contact us.

• Introduction
  • Usage Examples
• Installation
  • Dependencies
• Quickstart
  • Command-Line Renderer
  • Sphinx Builder
  • High-level PDF Library
• Basic Document Styling
  • Style Sheets
  • Document Templates
• Element Styling
  • Document Tree
  • Selectors
  • Matchers
  • Style Sheets
  • Style Logs
• Document Templates
  • Subclassing a Template
  • Creating a Custom Template
• Reference
  • rinoh
  • Sphinx Builder
  • Style Sheets
  • Standard Document Templates
• API Documentation
  • Attribute (rinoh.attribute)
  • Color (rinoh.color)
  • Dimension (rinoh.dimension)
  • Document (rinoh.document)
  • Drawing Primitives (rinoh.draw)
  • Flowable (rinoh.flowable)
  • Fonts and Typefaces (rinoh.font)
  • Images and Figures (rinoh.image)
  • Index (rinoh.index)
  • Language (rinoh.language)
  • Number (rinoh.number)
  • Paper sizes (rinoh.paper)
  • Paragraph (rinoh.paragraph)
  • Cross-References and Fields (rinoh.reference)
  • Structure (rinoh.structure)
  • Strings (rinoh.strings)
  • Style (rinoh.style)
  • Tables (rinoh.table)
  • Templates (rinoh.template)
• Frequenty Asked Questions
• Contributing
  • Contributor License Agreement
  • Coding guidelines
• Developing
  • Tox Environments
  • Testing against multiple Python interpreter versions
  • Continuous integration
  • Making a release
• Release History
  • Release 0.5.0 (2021-02-03)
  • Release 0.4.2 (2020-07-28)
  • Release 0.4.1 (2020-07-01)
  • Release 0.4.0 (2020-03-05)
  • Release 0.3.1 (2016-12-19)
  • Release 0.3.0 (2016-11-23)
  • Release 0.2.1 (2016-08-18)
  • Release 0.2.0 (2016-08-10)
  • Release 0.1.3 (2015-08-04)
  • Release 0.1.2 (2015-07-31)
  • Release 0.1.1 (2015-04-12)

Indices and tables

• Index

• Module Index