Metadata-Version: 2.1
Name: rst2pdf
Version: 0.0.0
Summary: Convert reStructured Text to PDF via ReportLab.
Home-page: https://rst2pdf.org
Author: rst2pdf maintainers
Author-email: maintainers@rstpdf.org
License: MIT
Download-URL: https://github.com/rst2pdf/rst2pdf/releases
Project-URL: Bug Reports, https://github.com/rst2pdf/rst2pdf/issues
Project-URL: Source, https://github.com/rst2pdf/rst2pdf
Description: .. image:: https://travis-ci.org/rst2pdf/rst2pdf.svg?branch=master
            :target: https://travis-ci.org/rst2pdf/rst2pdf
        
        .. image:: https://img.shields.io/pypi/v/rst2pdf.svg
            :target: https://pypi.org/project/rst2pdf/
        
        .. image:: https://img.shields.io/pypi/pyversions/rst2pdf.svg
            :target: https://pypi.org/project/rst2pdf/
        
        .. image:: https://img.shields.io/pypi/l/rst2pdf.svg
            :target: https://pypi.org/project/rst2pdf/
        
        =======================================
        rst2pdf: Use a text editor. Make a PDF.
        =======================================
        
        The usual way of creating PDF from reStructuredText is by going through LaTeX.
        This tool provides an alternative by producing PDF directly using the ReportLab
        library.
        
        More information is available `at the main website`__
        
        __ https://rst2pdf.org
        
        
        Features
        --------
        
        * User-defined page layout. Multiple frames per page, multiple layouts per
          document.
        
        * 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 and kerning (using wordaxe).
        
        * `Sphinx`__ integration
        
        * `Full user's manual`__
        
        __ https://www.sphinx-doc.org/
        __ https://rst2pdf.org/static/manual.pdf
        
        
        Installation
        ------------
        
        *rst2pdf* supports Python 3.6 or greater. Version 0.97 was the last version to support Python 2.7.
        
        Install from PyPI
        ~~~~~~~~~~~~~~~~~
        
        The latest released version may be installed from PyPI by using ``pip``::
        
            $ pip install --user rst2pdf
        
        Install from Snap
        ~~~~~~~~~~~~~~~~~
        
        If you are using a system that supports `snaps <https://snapcraft.io/>`__
        then you can install from there with::
        
            $ snap install rst2pdf
        
        Install from GitHub
        ~~~~~~~~~~~~~~~~~~~
        
        Work on rst2pdf has restarted on GitHub, with the goals of adding new
        features, addressing outstanding issues, and not breaking anything. You
        can 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 master
            $ pip install --user .
        
        You may want to install it in a virtualenv, but that is beyond the scope
        of this readme.
        
        
        Usage
        -----
        
        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 your ``conf.py`` file to enable
        the ``rst2pdf.pdfbuilder`` extension and configure the ``pdf_documents``
        option. 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 the ``pdf_documents`` option and the many other options
        available, refer to the `manual`__.
        
        __ https://rst2pdf.org/static/manual.pdf
        
        
        Contributing
        ------------
        
        rst2pdf wishes to be a welcoming community. With that in mind, please refer to our `Community Code of Conduct`__.
        
        __ CODE_OF_CONDUCT.rst
        
Keywords: restructured convert rst pdf docutils pygments reportlab
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Text Processing
Classifier: Topic :: Utilities
Requires-Python: >=3.6
Description-Content-Type: text/x-rst
Provides-Extra: aafiguresupport
Provides-Extra: hyphenation
Provides-Extra: mathsupport
Provides-Extra: rawhtmlsupport
Provides-Extra: sphinx
Provides-Extra: svgsupport
Provides-Extra: tests
