sphinxcontrib-bitbucket /

Filename Size Date modified Message
227 B
8.6 KB
1.3 KB
49 B
1.1 KB
15.0 KB
97 B
1.4 KB


This module adds custom roles for linking to resources on BitBucket projects.

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.



is equivalent to:

`issue 3 <http://bitbucket.org/birkenfeld/sphinx-contrib/issue/3/>`__



is equivalent to:

`changeset some-long-hash-value <http://bitbucket.org/birkenfeld/sphinx-contrib/changeset/some-long-hash-value/>`__

Configuration Parameters

The base URL for the project on BitBucket.org.



First public release.

Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.