Sphinx/BitBucket集成
项目描述
此模块为链接到BitBucket项目的资源添加了自定义角色。
基本用法
要使用此扩展,将其添加到您的Sphinx配置文件中的extensions
列表,并将变量bitbucket_project_url
设置为项目的基准URL。
例如
extensions = [ 'sphinxcontrib.bitbucket' ] bitbucket_project_url = 'http://bitbucket.org/birkenfeld/sphinx-contrib'
然后在您的rst文档中,使用角色bbissue
和bbchangeset
创建链接到票据和变更集。
这
:bbissue:`3`
等同于
`issue 3 <http://bitbucket.org/birkenfeld/sphinx-contrib/issue/3/>`__
和
:bbchangeset:`some-long-hash-value`
等同于
`changeset some-long-hash-value <http://bitbucket.org/birkenfeld/sphinx-contrib/changeset/some-long-hash-value/>`__
配置参数
- bitbucket_project_url
BitBucket.org上项目的基准URL。
历史
1.0
第一次公开发布。