Skip to content

renderer

Classes

AliasResolutionError

Source code in kiara/doc/mkdocstrings/renderer.py 
11
12
class AliasResolutionError:
    pass

KiaraInfoRenderer

Bases: BaseRenderer

Source code in kiara/doc/mkdocstrings/renderer.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
class KiaraInfoRenderer(BaseRenderer):

    default_config: dict = {}

    def get_anchors(
        self, data: CollectorItem
    ) -> typing.List[str]:  # noqa: D102 (ignore missing docstring)

        if data is None:
            return list()

        return list([data["identifier"], data["kiara_id"], data["obj"].get_id()])

    def render(self, data: typing.Dict[str, typing.Any], config: dict) -> str:

        # final_config = ChainMap(config, self.default_config)

        obj = data["obj"]
        html = obj.create_html()
        return html

Attributes

default_config: dict = {} class-attribute

Functions

get_anchors(data: CollectorItem) -> typing.List[str]
Source code in kiara/doc/mkdocstrings/renderer.py 
19
20
21
22
23
24
25
26
def get_anchors(
    self, data: CollectorItem
) -> typing.List[str]:  # noqa: D102 (ignore missing docstring)

    if data is None:
        return list()

    return list([data["identifier"], data["kiara_id"], data["obj"].get_id()])
render(data: typing.Dict[str, typing.Any], config: dict) -> str
Source code in kiara/doc/mkdocstrings/renderer.py 
28
29
30
31
32
33
34
def render(self, data: typing.Dict[str, typing.Any], config: dict) -> str:

    # final_config = ChainMap(config, self.default_config)

    obj = data["obj"]
    html = obj.create_html()
    return html