链接到GitHub问题、拉取请求、提交和Sphinx文档中的用户。
sphinxcontrib_github_alt的Python项目详细描述
链接到特定项目的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已经存在。伊普顿 &;jupyter项目已使用此扩展中定义的语法 在我们把它装进自己的包裹之前,我们不想换成 sphinxcontrib-github。