跳至主要内容
Ctrl+K

PyData 主题

  • 用户指南
  • 贡献者指南
  • 示例
  • 变更日志
    • API
    • PyData 网站
    • NumFocus
    • 捐赠给 NumFocus
  • Twitter
  • GitHub
  • PyPI
  • PyData
  • 用户指南
  • 贡献者指南
  • 示例
  • 变更日志
  • API
  • PyData 网站
  • NumFocus
  • 捐赠给 NumFocus
  • Twitter
  • GitHub
  • PyPI
  • PyData

章节导航

  • pydata_sphinx_theme
    • pydata_sphinx_theme.edit_this_page
    • pydata_sphinx_theme.logo
    • pydata_sphinx_theme.pygments
    • pydata_sphinx_theme.short_link
    • pydata_sphinx_theme.toctree
    • pydata_sphinx_theme.translator
    • pydata_sphinx_theme.utils
  • API 参考
  • pydata_sphinx_theme
  • pydata_sphinx_theme.short_link

pydata_sphinx_theme.short_link#

一个自定义的 Transform 对象,用于缩短 github 和 gitlab 链接。

类#

ShortenLinkTransform

当链接来自 github 或 gitlab 时,缩短链接,并为标签添加额外的类,以便进一步的样式设置。

模块内容#

class pydata_sphinx_theme.short_link.ShortenLinkTransform(document, startnode=None)[source]#

基类: sphinx.transforms.post_transforms.SphinxPostTransform

当链接来自 github 或 gitlab 时,缩短链接,并为标签添加额外的类,以便进一步的样式设置。

之前
<a class="reference external" href="https://github.com/2i2c-org/infrastructure/issues/1329">
  https://github.com/2i2c-org/infrastructure/issues/1329
</a>
之后
<a class="reference external github" href="https://github.com/2i2c-org/infrastructure/issues/1329">
   2i2c-org/infrastructure#1329
</a>
parse_url(uri)[source]#

根据选定的平台解析 url 的内容。

参数:

uri (urllib.parse.ParseResult) – 到平台内容的链接

返回值:

重新格式化的 url 标题

返回类型:

str

run(**kwargs)[source]#

运行 Transform 对象。

default_priority = 400[source]#

此转换的数字优先级,0 到 999(覆盖)。

formats = ('html',)[source]#
platform = None[source]#
supported_platform: ClassVar[dict[str, str]][source]#

previous

pydata_sphinx_theme.pygments

next

pydata_sphinx_theme.toctree

本页内容
  • 类
  • 模块内容
    • ShortenLinkTransform
      • ShortenLinkTransform.parse_url()
      • ShortenLinkTransform.run()
      • ShortenLinkTransform.default_priority
      • ShortenLinkTransform.formats
      • ShortenLinkTransform.platform
      • ShortenLinkTransform.supported_platform
在 GitHub 上编辑
显示源代码

© 版权所有 2019,PyData 社区。

使用 Sphinx 8.1.3 创建。

使用 PyData Sphinx 主题 0.16.0 构建。