pydata_sphinx_theme.short_link#

Classes#

Module Contents#

class pydata_sphinx_theme.short_link.ShortenLinkTransform(document, startnode=None)[源代码]#

Bases: sphinx.transforms.post_transforms.SphinxPostTransform

Shorten link when they are coming from github or gitlab and add an extra class to the tag for further styling.

Before:

<a class="reference external"
    href="https://github.com/2i2c-org/infrastructure/issues/1329">
    https://github.com/2i2c-org/infrastructure/issues/1329
</a>

After:

<a class="reference external github"
    href="https://github.com/2i2c-org/infrastructure/issues/1329">
    2i2c-org/infrastructure#1329
</a>

parse_url(uri)[源代码]#

Parse the content of the url with respect to the selected platform.

参数:

uri (urllib.parse.ParseResult) -- the link to the platform content

返回:

the reformated url title

返回类型:

str

run(**kwargs)[源代码]#

Run the Transform object.

default_priority = 400[源代码]#

Numerical priority of this transform, 0 through 999 (override).

formats = ('html',)[源代码]#

platform = None[源代码]#

supported_platform: ClassVar[dict[str, str]][源代码]#