A Sphinx extension to reference issues in an issue tracker.
The extension is available under the terms of the BSD license, see License for more information.
Use pip to install this extension straight from the Python Package Index:
pip install sphinxcontrib-issuetracker
This extension requires Sphinx 1.1 and Python 2.6 or Python 3.1.
Some builtin issue trackers do not support Python 3 currently. Refer to issuetracker for more information.
Add this extension to extensions and configure the issue tracker to use and the project in your conf.py:
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 Usage and operation and Configuration chapters. If this extension does not yet support the issue tracker you’re using, read the Customization chapter and implement support for your tracker.
Please report issues to the issue tracker if you have trouble, found a bug in this extension or lack support for a specific issue tracker, but respect the following rules:
The source code is hosted on Github:
Please fork the repository and send pull requests with your fixes or cool new features, but respect the following rules:
sphinxcontrib-issuetracker is written and maintained by Sebastian Wiesner <firstname.lastname@example.org>
The following people, listed alphabetically, contributed to this extension or supported its development otherwise:
Many thanks for all contributions!