Skip to main content

A Sphinx extension for linking to your project's issue tracker

Project description

https://travis-ci.org/sloria/sphinx-issues.svg?branch=master

A Sphinx extension for linking to your project’s issue tracker. Includes roles for linking to both issues and user profiles, with built-in support for GitHub (though this works with other services).

Example

For an example usage, check out marshmallow’s changelog, which makes use of the roles in this library.

Installation and Configuration

$ pip install sphinx-issues

Add sphinx_issues to extensions in your conf.py. If your project is on Github, add the issues_github_path config variable. Otherwise, use issues_uri.

# docs/conf.py

#...
extensions = [
    #...
    'sphinx_issues',
]

# Github repo
issues_github_path = 'sloria/marshmallow'

# equivalent to
issues_uri = 'https://github.com/sloria/marshmallow/issues/{issue}'

Usage

Use the :issue: role in your docs like so:

See issue :issue:`42`

See issues :issue:`12,13`

Use the :user: role in your docs to link to user profiles (Github by default, but can be configured via the issues_user_uri config variable).

Thanks to :user:`bitprophet` for the idea!

Credits

Credit goes to Jeff Forcier for his work on the releases extension, which is a full-featured solution for generating changelogs. I just needed a quick way to reference Github issues in my docs, so I yoinked the bits that I needed.

License

MIT licensed. See the bundled LICENSE file for more details.

Changelog

0.2.0 (2014-12-22)

  • Add :user: role for linking to Github user profiles.

0.1.0 (2014-12-21)

  • Initial release.

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

sphinx-issues-0.2.0.tar.gz (4.1 kB view hashes)

Uploaded source

Built Distribution

sphinx_issues-0.2.0-py2.py3-none-any.whl (6.4 kB view hashes)

Uploaded 2 7

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