1. Doug Hellmann
  2. sphinxcontrib-bitbucket

Source

sphinxcontrib-bitbucket /

Filename Size Date modified Message
sphinxcontrib
227 B
add sqltable extension
8.6 KB
Added tag clearquest-0.5 for changeset a2776a69adc3
1.3 KB
remove other projects and rearrange repository
49 B
remove other projects and rearrange repository
1.1 KB
remove other projects and rearrange repository
15.0 KB
remove other projects and rearrange repository
97 B
remove other projects and rearrange repository
1.4 KB
remove other projects and rearrange repository

sphinxcontrib.bitbucket

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.

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.

History

1.0

First public release.