*************************************
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_format``
The value provided to the RSVG converter's ``--format`` argument. In more
recent RSVG builds, the ``pdf1.5`` format will generate the fewest warnings
with LaTeX backends. By default, this is ``pdf``.
``rsvg_converter_args``
Additional command-line arguments for the RSVG converter, as a list. By
default, this is the empty list ``[]``.
CairoSVG
--------
No configuration is required.
Raw data
{
"_id": null,
"home_page": "https://github.com/missinglinkelectronics/sphinxcontrib-svg2pdfconverter",
"name": "sphinxcontrib-svg2pdfconverter",
"maintainer": null,
"docs_url": null,
"requires_python": "~=3.4",
"maintainer_email": null,
"keywords": null,
"author": "Stefan Wiehler",
"author_email": "sphinx_contribute@missinglinkelectronics.com",
"download_url": "https://files.pythonhosted.org/packages/55/df/038c33dd93daea6ca91f8168a5bbcab7744f030005a15e23d6a50793a264/sphinxcontrib_svg2pdfconverter-1.2.3.tar.gz",
"platform": "any",
"description": "*************************************\nSphinx SVG to PDF Converter Extension\n*************************************\n\nThis extension converts SVG images to PDF in case the builder does not support\nSVG images natively (e.g. LaTeX).\n\nInternally, either `Inkscape <https://inkscape.org/>`_, ``rsvg-convert``\nfrom `libRSVG <https://wiki.gnome.org/Projects/LibRsvg>`_ or `CairoSVG\n<https://cairosvg.org/>`_ as progressively more lightweight alternatives\nare used to convert images.\n\n\nInstallation\n============\n\nJust install via ``pip``:\n\n.. code-block:: console\n\n $ pip install sphinxcontrib-svg2pdfconverter\n\nYou can choose between Inkscape, libRSVG and CairoSVG by adding\n``sphinxcontrib.inkscapeconverter``, ``sphinxcontrib.rsvgconverter`` or\n``sphinxcontrib.cairosvgconverter`` to the ``extensions`` list in your\n``conf.py``.\n\nMake sure to have either ``inkscape`` or the ``rsvg-convert`` command available\nin your systems ``PATH`` and, if necessary, adapt the\n``inkscape_converter_bin`` or ``rsvg_converter_bin`` config value respectively.\n\nCairoSVG requires additional dependencies to be installed with:\n\n.. code-block:: console\n\n $ pip install sphinxcontrib-svg2pdfconverter[CairoSVG]\n\nCairoSVG and its dependencies may require additional tools during the\ninstallation depending on the OS you are using; see the `CairoSVG documentation\n<https://cairosvg.org/documentation/#installation>`_ for further details.\n\nConfiguration\n=============\n\nInkscape\n--------\n\n``inkscape_converter_bin``\n Path to Inkscape binary. By default, this is ``inkscape``.\n\n``inkscape_converter_args``\n Additional command-line arguments for Inkscape, as a list. By\n default, this is ``['--export-area-drawing']``.\n\nRSVG\n----\n\n``rsvg_converter_bin``\n Path to RSVG converter binary. By default, this is ``rsvg-convert``.\n\n``rsvg_converter_format``\n The value provided to the RSVG converter's ``--format`` argument. In more\n recent RSVG builds, the ``pdf1.5`` format will generate the fewest warnings\n with LaTeX backends. By default, this is ``pdf``.\n\n``rsvg_converter_args``\n Additional command-line arguments for the RSVG converter, as a list. By\n default, this is the empty list ``[]``.\n\nCairoSVG\n--------\n\nNo configuration is required.\n",
"bugtrack_url": null,
"license": "BSD",
"summary": "Sphinx SVG to PDF converter extension",
"version": "1.2.3",
"project_urls": {
"Download": "https://pypi.org/project/sphinxcontrib-svg2pdfconverter",
"Homepage": "https://github.com/missinglinkelectronics/sphinxcontrib-svg2pdfconverter"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f1858563d13887eb4181ff8cab9c97dc841bf3752a0df63c8d5fd2e890d2e7e7",
"md5": "8ea94e70308680752a36c5b24860ea9b",
"sha256": "f757330fc0f89c2e4768d85e385b6dd6edc67f7ccb09b3dc6939cbcaf57a88ea"
},
"downloads": -1,
"filename": "sphinxcontrib_svg2pdfconverter-1.2.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8ea94e70308680752a36c5b24860ea9b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "~=3.4",
"size": 8176,
"upload_time": "2024-09-12T16:25:30",
"upload_time_iso_8601": "2024-09-12T16:25:30.589177Z",
"url": "https://files.pythonhosted.org/packages/f1/85/8563d13887eb4181ff8cab9c97dc841bf3752a0df63c8d5fd2e890d2e7e7/sphinxcontrib_svg2pdfconverter-1.2.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "55df038c33dd93daea6ca91f8168a5bbcab7744f030005a15e23d6a50793a264",
"md5": "a47eca1420aa3a7796fa1d6da599cbc0",
"sha256": "fb5d517b634c5629522004c59edce4d9050d89822408cab452c7d52fe5ae9824"
},
"downloads": -1,
"filename": "sphinxcontrib_svg2pdfconverter-1.2.3.tar.gz",
"has_sig": false,
"md5_digest": "a47eca1420aa3a7796fa1d6da599cbc0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.4",
"size": 5774,
"upload_time": "2024-09-12T16:25:32",
"upload_time_iso_8601": "2024-09-12T16:25:32.190277Z",
"url": "https://files.pythonhosted.org/packages/55/df/038c33dd93daea6ca91f8168a5bbcab7744f030005a15e23d6a50793a264/sphinxcontrib_svg2pdfconverter-1.2.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-12 16:25:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "missinglinkelectronics",
"github_project": "sphinxcontrib-svg2pdfconverter",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"tox": true,
"lcname": "sphinxcontrib-svg2pdfconverter"
}
JSON
