sphinx-github-role

Sphinx的github角色。

安装

要安装，请运行

(.venv) $ pip install sphinx-github-role

使用方法

基本用法

MyST

:caption: index.md
See {github}`astrojuanlu/sphinx-github-role#1`.

reStructuredText

:caption: index.rst
See :github:`astrojuanlu/sphinx-github-role#1`.

配置默认组织和项目

扩展接受一个配置github_default_org_project，它可以是一个元组("default_org", "default_project")以节省一些输入。例如，使用此配置

:caption: conf.py
github_default_org_project = ("astrojuanlu", None)

您可以输入此内容

:caption: index.md
See {github}`sphinx-github-role#1`.

使用此配置

:caption: conf.py
github_default_org_project = ("astrojuanlu", "sphinx-github-role")

您只需要输入此内容

:caption: index.md
See {github}`#1`.

自定义链接文本

您还可以通过将目标包裹在尖括号中来自定义链接文本

:caption: index.md
See {github}`this issue <#1>`.

贡献

欢迎您提出问题或建议新功能！