Skip to main content

Sphinx/BitBucket integration

Project description

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.

Project details


Release history Release notifications | RSS feed

This version

1.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for sphinxcontrib-bitbucket, version 1.0
Filename, size File type Python version Upload date Hashes
Filename, size sphinxcontrib-bitbucket-1.0.tar.gz (8.3 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page