GitHub links in Sphinx docs

喜夏-厌秋 提交于 2019-12-24 16:33:06

问题


Here's an example Sphinx doc: https://github.com/django-tastypie/django-tastypie/blob/v0.13.2/docs/release_notes/v0.13.2.rst

I'd like commit SHA's, issue numbers, and @mentions to be hyperlinked. Anyway to do that automatically?


回答1:


I'd suggest checking out the Sphinx Extension library at http://sphinxext-survey.readthedocs.org/en/latest/changelog-version-control.html.

Specifically, I believe these two extensions may provide you at least some of the support you're looking for (sans the @mentions).

https://pypi.python.org/pypi/sphinxcontrib-github

https://pypi.python.org/pypi/sphinxcontrib-issuetracker



来源:https://stackoverflow.com/questions/35415570/github-links-in-sphinx-docs

易学教程内所有资源均来自网络或用户发布的内容,如有违反法律规定的内容欢迎反馈
该文章没有解决你所遇到的问题?点击提问,说说你的问题,让更多的人一起探讨吧!