Python render_module Examples

Example #1

def test_module_empty_filters():
    module = get_module("mkapi.core.base")
    m = renderer.render_module(module).split("\n")
    assert m[0] == "# ![mkapi](mkapi.core.base|plain|link|sourcelink)"
    assert m[2] == "## ![mkapi](mkapi.core.base.Base||link|sourcelink)"
    assert m[3] == "## ![mkapi](mkapi.core.base.Inline||link|sourcelink)"
    assert m[4] == "## ![mkapi](mkapi.core.base.Type||link|sourcelink)"
    assert m[5] == "## ![mkapi](mkapi.core.base.Item||link|sourcelink)"

Example #2

File: module.py Project: orf/mkapi

    def get_markdown(self, filters: List[str]) -> str:  # type:ignore
        """Returns a Markdown source for docstring of this object.

        Args:
            filters: A list of filters. Avaiable filters: `upper`, `inherit`,
                `strict`.
        """
        from mkapi.core.renderer import renderer

        return renderer.render_module(self, filters)  # type:ignore