Docs: mention rinohtype as an alternative PDF builder

This commit is contained in:
Brecht Machiels 2017-06-05 14:51:35 +02:00
parent c6699eb6b8
commit 4749157bd3
3 changed files with 26 additions and 14 deletions

View File

@ -226,11 +226,17 @@ The builder's "name" must be given to the **-b** command-line option of
.. autoattribute:: supported_image_types .. autoattribute:: supported_image_types
Note that a direct PDF builder using ReportLab is available in `rst2pdf Note that a direct PDF builder is being provided by `rinohtype`_. The builder's
<https://github.com/rst2pdf/rst2pdf>`_ version 0.12 or greater. You need to add name is ``rinoh``. Refer to the `rinohtype manual`_ for details. There is also
``'rst2pdf.pdfbuilder'`` to your :confval:`extensions` to enable it, its name is PDF builder using ReportLab in `rst2pdf`_ version 0.12 or greater. However,
``pdf``. Refer to the `rst2pdf manual <https://ralsina.me/static/manual.pdf>`_ rst2pdf is no longer being actively maintained and suffers from some problems
for details. when used with recent Sphinx versions. See the `rst2pdf manual`_ for usage
instructions.
.. _rinohtype: https://github.com/brechtm/rinohtype
.. _rinohtype manual: http://www.mos6581.org/rinohtype/quickstart.html#sphinx-builder
.. _rst2pdf: https://github.com/rst2pdf/rst2pdf
.. _rst2pdf manual: http://ralsina.me/static/manual.pdf
.. module:: sphinx.builders.text .. module:: sphinx.builders.text
.. class:: TextBuilder .. class:: TextBuilder

View File

@ -10,9 +10,13 @@ How do I...
----------- -----------
... create PDF files without LaTeX? ... create PDF files without LaTeX?
You can use `rst2pdf <https://github.com/rst2pdf/rst2pdf>`_ version 0.12 or `rinohtype`_ provides a PDF builder that can be used as a drop-in
greater which comes with built-in Sphinx integration. See the replacement for the LaTeX builder. Alternatively, you can use `rst2pdf`_
:ref:`builders` section for details. version 0.12 or greater which comes with built-in Sphinx integration. See
the :ref:`builders` section for details.
.. _rinohtype: https://github.com/brechtm/rinohtype
.. _rst2pdf: https://github.com/rst2pdf/rst2pdf
... get section numbers? ... get section numbers?
They are automatic in LaTeX output; for HTML, give a ``:numbered:`` option to They are automatic in LaTeX output; for HTML, give a ``:numbered:`` option to

View File

@ -7,19 +7,21 @@ formats, automatically producing cross-references, indices etc. That is, if
you have a directory containing a bunch of reST-formatted documents (and you have a directory containing a bunch of reST-formatted documents (and
possibly subdirectories of docs in there as well), Sphinx can generate a possibly subdirectories of docs in there as well), Sphinx can generate a
nicely-organized arrangement of HTML files (in some other directory) for easy nicely-organized arrangement of HTML files (in some other directory) for easy
browsing and navigation. But from the same source, it can also generate a browsing and navigation. But from the same source, it can also generate a PDF
LaTeX file that you can compile into a PDF version of the documents, or a file using LaTeX, `rinohtype`_ or `rst2pdf`_ (see :ref:`builders`).
PDF file directly using `rst2pdf <https://github.com/rst2pdf/rst2pdf>`_.
The focus is on hand-written documentation, rather than auto-generated API docs. The focus is on hand-written documentation, rather than auto-generated API docs.
Though there is support for that kind of docs as well (which is intended to be Though there is support for that kind of documentation as well (which is
freely mixed with hand-written content), if you need pure API docs have a look intended to be freely mixed with hand-written content), if you need pure API
at `Epydoc <http://epydoc.sourceforge.net/>`_, which also understands reST. docs have a look at `Epydoc <http://epydoc.sourceforge.net/>`_, which also
understands reST.
For a great "introduction" to writing docs in general -- the whys and hows, see For a great "introduction" to writing docs in general -- the whys and hows, see
also `Write the docs <http://write-the-docs.readthedocs.org/>`_, written by Eric also `Write the docs <http://write-the-docs.readthedocs.org/>`_, written by Eric
Holscher. Holscher.
.. _rinohtype: https://github.com/brechtm/rinohtype
.. _rst2pdf: https://github.com/rst2pdf/rst2pdf
Conversion from other systems Conversion from other systems
----------------------------- -----------------------------