sphinxcontrib-bitbucketSphinx/BitBucket integration | |
Download |
sphinxcontrib-bitbucket Ranking & Summary
Advertisement
- License:
- BSD License
- Price:
- FREE
- Publisher Name:
- Doug Hellmann
- Publisher web site:
- http://www.doughellmann.com
sphinxcontrib-bitbucket Tags
sphinxcontrib-bitbucket Description
Sphinx/BitBucket integration sphinxcontrib-bitbucket is a Python module that adds custom roles for linking to resources on BitBucket projects.Basic UsageTo 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 = 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 Parametersbitbucket_project_url The base URL for the project on BitBucket.org. Requirements: · Python
sphinxcontrib-bitbucket Related Software