Skip to main content

Sphinx integration with different issuetrackers

Project description

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.

Support

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.

Development

The source code is hosted on Github:

git clone https://github.com/lunaryorn/sphinxcontrib-issuetracker

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

Project details


Download files

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

Source Distribution

sphinxcontrib-issuetracker-0.11.tar.gz (30.4 kB view details)

Uploaded Source

File details

Details for the file sphinxcontrib-issuetracker-0.11.tar.gz.

File metadata

File hashes

Hashes for sphinxcontrib-issuetracker-0.11.tar.gz
Algorithm Hash digest
SHA256 843753d8b5e989116378ab45ecccb368fb78dc56eaa1554ed25e4fbf22745f4e
MD5 69c2f0e5770c5d7bad73f60f8d764e28
BLAKE2b-256 bddc7802f5cb801e9af00372dd95dc58de6f3b3821082b33acae1b159789f939

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page