Sphinx extension to reference issues in issue trackers
Python
Pull request Compare This branch is 21 commits behind ignatenkobrain:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
doc
sphinxcontrib
tests
.gitignore
.travis.yml
CHANGES.rst
CREDITS
LICENSE
MANIFEST.in
README.rst
requirements.txt
setup.cfg
setup.py
tox.ini

README.rst

sphinxcontrib-issuetracker

https://secure.travis-ci.org/lunaryorn/sphinxcontrib-issuetracker.png

http://sphinxcontrib-issuetracker.readthedocs.org/

A Sphinx extension to reference issues in issue trackers, either explicitly with an "issue" role or optionally implicitly by issue ids like #10 in plaintext.

Currently the following issue trackers are supported:

A simple API is provided to add support for other issue trackers. If you added support for a new tracker, please consider sending a patch to make your work available to other users of this extension.

Installation

This extension can be installed from the Python Package Index:

pip install sphinxcontrib-issuetracker

This extension requires Sphinx 1.1 and Pythonn 2.6 or Python 3.1.

Usage

Just add this extension to extensions and configure your issue tracker:

extensions = ['sphinxcontrib.issuetracker']

issuetracker = 'github'
issuetracker_project = 'lunaryorn/sphinxcontrib-issuetracker'

Now issue references like #10 are replaced with links to the issue tracker of this extension, unless the reference occurs in literal text like inline literals or code blocks.

You can disable this magic behaviour by setting issuetracker_plaintext_issues to False:

issuetracker_plaintext_issues = False

Now textual references are no longer replaced. However, you can still explicitly reference issues with the issue role.

For more details refer to the documentation.