.. image:: https://img.shields.io/pypi/pyversions/rinohtype.svg :target: https://pypi.python.org/pypi/rinohtype :alt: Python version
.. image:: https://codecov.io/gh/brechtm/rinohtype/branch/master/graph/badge.svg :target: https://codecov.io/gh/brechtm/rinohtype :alt: Test coverage
rinohtype is a batch-mode document processor. It renders structured documents to PDF based on a document template and a style sheet. An important design goal of rinohtype is make document layout and style customization user-friendly. See the documentation_ to learn how to customize the style of your document.
Since rinohtype is a fairly sizable project and currently being maintained by a single person, your contribution can make a big difference. Specifically, the following things can help move rinohtype forward:
So if you are interested in helping with any of these items, please don't
hesitate to get in touch via [email protected],
GitHub issues_ or Gitter_!
rinohtype is still in beta, so you might run into some issues when using it.
I'd highly appreciate it if you could
create a ticket_ for any bugs you may
encounter. That said, rinohtype is already quite capable. For example, it
should be able to replace Sphinx_'s LaTeX builder in most cases. Here is an
overview of the main features:
rinohtype's primary input format is reStructuredText_. The
line tool renders reStructuredText documents and the included Sphinx_ builder
makes it possible to output large documents with your own style applied. Have
a look at the
rinohtype manual_ for an example of the output.
There is also a commercial DITA_ frontend, but it's development is currently
on hold. Please
contact me_ if you are interested in testing it.
.. _documentation: http://www.mos6581.org/rinohtype/master/ .. _create a ticket: https://github.com/brechtm/rinohtype/issues/new/choose .. _reStructuredText: http://docutils.sourceforge.net/rst.html .. _Sphinx: http://sphinx-doc.org .. _rinohtype manual: http://www.mos6581.org/rinohtype/master/manual.pdf .. _DITA: https://en.wikipedia.org/wiki/Darwin_Information_Typing_Architecture .. _contact me: [email protected]
rinohtype supports all stable Python 3 versions that have not reached end-of-life_ status. For parsing reStructuredText and CommonMark documents, rinohtype depends on docutils_ and recommonmark_ respectively. pip_ takes care of installing these requirements when you install rinohtype.
Syntax highlighting of code blocks is eneabled if Pygments_ is installed, which will be installed automatically with Sphinx_. If you want to include images other than PDF, PNG or JPEG, you also need to install Pillow_.
.. _end-of-life: https://devguide.python.org/#status-of-python-branches .. _docutils: http://docutils.sourceforge.net/index.html .. _recommonmark: https://recommonmark.readthedocs.io .. _pip: https://pip.pypa.io .. _Pygments: https://pygments.org .. _Pillow: http://python-pillow.github.io
Installation is trivial::
pip install rinohtype
The easiest way to get started with rinohtype is to render a reStructuredText document (such as ``CHANGES.rst`` from this repository) using the ``rinoh`` command line tool:: rinoh CHANGES.rst When ``rinoh`` finishes, you will find ``CHANGES.pdf`` alongside the input file. By default ``rinoh`` renders the input document using the article template. Run ``rinoh --help`` to see how you can tell ``rinoh`` which document template and style sheet to use. Sphinx Builder ~~~~~~~~~~~~~~ rinohtype can be used as a drop-in replacement for the LaTeX builder (the ``latex_documents`` configuration variable has to be set). Simply select the `rinoh` builder when building the Sphinx project:: sphinx-build -b rinoh . _build/rinoh Contributing ------------ See ``CONTRIBUTING.rst`` and ``DEVELOPING.rst`` License ------- All of rinohtype's source code is licensed under the `Affero GPL 3.0`_, unless indicated otherwise in the source file (such as ``hyphenator.py`` and ``purepng.py``). The Affero GPL requires for software that builds on rinohtype to also be released as open source under this license. For building closed-source applications, you can obtain a `commercial license`_. The author of rinohtype is also available for consultancy projects involving rinohtype. .. _Affero GPL 3.0: https://www.gnu.org/licenses/agpl-3.0.html .. _commercial license: `contact me`_