跳转到主要内容

从Sphinx文档链接到GitHub问题、拉取请求、提交和用户。

项目描述

链接到特定项目的GitHub问题、拉取请求、提交和用户。

要使用此扩展,请将其添加到 conf.py 中的 extensions 列表,并设置变量 github_project_url

extensions = [...
              'sphinxcontrib_github_alt',
             ]

github_project_url = "https://github.com/ipython/ipython"

然后在您的文档中使用以下角色

* :ghissue:`12` - link to issue #12
* :ghpull:`35` - link to pull request #35
* :ghcommit:`3a1cb54` - link to commit
* :ghuser:`ipython` - link to a user or organisation

它被称为“alt”,因为 sphinxcontrib-github 已经存在。IPython & Jupyter项目在将其作为独立包之前就已经使用这个扩展中定义的语法了一段时间,所以我们不想切换到 sphinxcontrib-github

项目详情


下载文件

下载适用于您的平台的文件。如果您不确定选择哪个,请了解有关 安装软件包 的更多信息。

源代码分发

sphinxcontrib_github_alt-1.2.tar.gz (4.0 kB 查看哈希值)

上传时间 源代码

构建分发

sphinxcontrib_github_alt-1.2-py2.py3-none-any.whl (4.3 kB 查看哈希值)

上传于 Python 2 Python 3

由以下支持