summaryrefslogtreecommitdiffstats
path: root/tests/roots/test-ext-imgmockconverter/mocksvgconverter.py
blob: 43368de9daaf68943b94f48fb45e06b3f0b28515 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
"""
    Does foo.svg --> foo.pdf with no change to the file.
"""

import shutil

from sphinx.transforms.post_transforms.images import ImageConverter

if False:
    # For type annotation
    from typing import Any, Dict  # NOQA

    from sphinx.application import Sphinx  # NOQA

class MyConverter(ImageConverter):
    conversion_rules = [
        ('image/svg+xml', 'application/pdf'),
    ]

    def is_available(self):
        # type: () -> bool
        return True

    def convert(self, _from, _to):
        # type: (unicode, unicode) -> bool
        """Mock converts the image from SVG to PDF."""
        shutil.copyfile(_from, _to)
        return True


def setup(app):
    # type: (Sphinx) -> Dict[unicode, Any]
    app.add_post_transform(MyConverter)

    return {
        'version': 'builtin',
        'parallel_read_safe': True,
        'parallel_write_safe': True,
    }