Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (
Help us improve Python packaging - Donate today!

Sphinx integration with different issuetrackers

Project Description

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.


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.


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.


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:

  • Check that the issue has not already been reported.
  • Check that the issue is not already fixed in the master branch.
  • Open issues with clear title and a detailed description in grammatically correct, complete sentences.


The source code is hosted on Github:

git clone

Please fork the repository and send pull requests with your fixes or cool new features, but respect the following rules:

Release History

This version
History Node


History Node


History Node


History Node


History Node


History Node


History Node


Download Files

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

Filename, Size & Hash SHA256 Hash Help File Type Python Version Upload Date
(30.4 kB) Copy SHA256 Hash SHA256
Source None Jan 17, 2013

Supported By

Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Google Google Cloud Servers DreamHost DreamHost Log Hosting