Name | Date | Size | #Lines | LOC | ||
---|---|---|---|---|---|---|
.. | 03-May-2022 | - | ||||
sphinxcontrib/ | H | 03-May-2022 | - | 136 | 102 | |
sphinxcontrib_bitbucket.egg-info/ | H | 03-May-2022 | - | 72 | 49 | |
LICENSE | H A D | 06-Nov-2010 | 1.3 KiB | 26 | 21 | |
MANIFEST.in | H A D | 06-Nov-2010 | 49 | 4 | 3 | |
PKG-INFO | H A D | 24-Apr-2011 | 2.1 KiB | 72 | 49 | |
README | H A D | 06-Nov-2010 | 1.1 KiB | 54 | 32 | |
distribute_setup.py | H A D | 06-Nov-2010 | 14.9 KiB | 478 | 386 | |
setup.cfg | H A D | 24-Apr-2011 | 97 | 9 | 6 | |
setup.py | H A D | 03-May-2022 | 1.2 KiB | 43 | 34 |
README
1######################## 2sphinxcontrib.bitbucket 3######################## 4 5This module adds custom roles for linking to resources on BitBucket 6projects. 7 8Basic Usage 9=========== 10 11To use this extension, add it to the ``extensions`` list in your 12Sphinx configuration file and set the variable 13``bitbucket_project_url`` to the base URL for the project. 14 15For example:: 16 17 extensions = [ 'sphinxcontrib.bitbucket' ] 18 19 bitbucket_project_url = 'http://bitbucket.org/birkenfeld/sphinx-contrib' 20 21Then in your rst documents, use the roles ``bbissue`` and 22``bbchangeset`` to create links to tickets and changesets. 23 24This:: 25 26 :bbissue:`3` 27 28is equivalent to:: 29 30 `issue 3 <http://bitbucket.org/birkenfeld/sphinx-contrib/issue/3/>`__ 31 32and:: 33 34 :bbchangeset:`some-long-hash-value` 35 36is equivalent to:: 37 38 `changeset some-long-hash-value <http://bitbucket.org/birkenfeld/sphinx-contrib/changeset/some-long-hash-value/>`__ 39 40Configuration Parameters 41======================== 42 43bitbucket_project_url 44 The base URL for the project on BitBucket.org. 45 46 47History 48======= 49 501.0 51--- 52 53First public release. 54