Metadata-Version: 2.1
Name: sphinxcontrib-svg2pdfconverter
Version: 1.1.1
Summary: Sphinx SVG to PDF converter extension
Home-page: https://github.com/missinglinkelectronics/sphinxcontrib-svg2pdfconverter
Author: Stefan Wiehler
Author-email: stefan.wiehler@missinglinkelectronics.com
License: BSD
Download-URL: https://pypi.org/project/sphinxcontrib-svg2pdfconverter
Description: *************************************
        Sphinx SVG to PDF Converter Extension
        *************************************
        
        This extension converts SVG images to PDF in case the builder does not support
        SVG images natively (e.g. LaTeX).
        
        Internally, either `Inkscape <https://inkscape.org/>`_, ``rsvg-convert``
        from `libRSVG <https://wiki.gnome.org/Projects/LibRsvg>`_ or `CairoSVG
        <https://cairosvg.org/>`_ as progressively more lightweight alternatives
        are used to convert images.
        
        
        Installation
        ============
        
        Just install via ``pip``:
        
        .. code-block:: console
        
           $ pip install sphinxcontrib-svg2pdfconverter
        
        You can choose between Inkscape, libRSVG and CairoSVG by adding
        ``sphinxcontrib.inkscapeconverter``, ``sphinxcontrib.rsvgconverter`` or
        ``sphinxcontrib.cairosvgconverter`` to the ``extensions`` list in your
        ``conf.py``.
        
        Make sure to have either ``inkscape`` or the ``rsvg-convert`` command available
        in your systems ``PATH`` and, if necessary, adapt the
        ``inkscape_converter_bin`` or ``rsvg_converter_bin`` config value respectively.
        
        CairoSVG requires additional dependencies to be installed with:
        
        .. code-block:: console
        
           $ pip install sphinxcontrib-svg2pdfconverter[CairoSVG]
        
        CairoSVG and its dependencies may require additional tools during the
        installation depending on the OS you are using; see the `CairoSVG documentation
        <https://cairosvg.org/documentation/#installation>`_ for further details.
        
        Configuration
        =============
        
        Inkscape
        --------
        
        ``inkscape_converter_bin``
            Path to Inkscape binary. By default, this is ``inkscape``.
        
        ``inkscape_converter_args``
            Additional command-line arguments for Inkscape, as a list. By
            default, this is ``['--export-area-drawing']``.
        
        RSVG
        ----
        
        ``rsvg_converter_bin``
            Path to RSVG converter binary. By default, this is ``rsvg-convert``.
        
        ``rsvg_converter_args``
            Additional command-line arguments for the RSVG converter, as a list. By
            default, this is the emtpy list ``[]``.
        
        CairoSVG
        --------
        
        No configuration is required.
        
Platform: any
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Framework :: Sphinx :: Extension
Classifier: Topic :: Documentation
Classifier: Topic :: Utilities
Requires-Python: ~=3.4
Description-Content-Type: text/x-rst
Provides-Extra: CairoSVG
