sphinxcontrib.bitbucket¶
Add custom roles to the rst processor in Sphinx to make it easy to link to BitBucket resources like issues and changesets.
Basic Usage¶
To use this extension, add it to the extensions list in your Sphinx configuration file and set the variable bitbucket_project_url to the base URL for the project.
For example:
extensions = [ 'sphinxcontrib.bitbucket' ]
bitbucket_project_url = 'http://bitbucket.org/birkenfeld/sphinx-contrib'
Then in your rst documents, use the roles bbissue and bbchangeset to create links to tickets and changesets.
This:
:bbissue:`3`
is equivalent to:
`issue 3 <http://bitbucket.org/birkenfeld/sphinx-contrib/issue/3/>`__
and:
:bbchangeset:`some-long-hash-value`
is equivalent to:
`changeset some-long-hash-value <http://bitbucket.org/birkenfeld/sphinx-contrib/changeset/some-long-hash-value/>`__
Configuration Parameters¶
- bitbucket_project_url
- The base URL for the project on BitBucket.org.
Installation¶
Download the latest release from the PyPI page. or install with pip install sphinxcontrib-bitbucket.
Support¶
This project is hosted on bitbucket.org as part of the Sphinx contributions project: https://bitbucket.org/birkenfeld/sphinx-contrib
Please report issues via the bug tracker.
License¶
Copyright Doug Hellmann, All Rights Reserved
Permission to use, copy, modify, and distribute this software and its documentation for any purpose and without fee is hereby granted, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation, and that the name of Doug Hellmann not be used in advertising or publicity pertaining to distribution of the software without specific, written prior permission.
DOUG HELLMANN DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL DOUG HELLMANN BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
