Skip to main content

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

Project description

A Sphinx extension for linking to your project’s issue tracker.

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`

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.1.0

  • 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.

Files for sphinx-issues, version 0.1.0
Filename, size File type Python version Upload date Hashes
Filename, size sphinx_issues-0.1.0-py2.py3-none-any.whl (5.5 kB) File type Wheel Python version 2.7 Upload date Hashes View hashes
Filename, size sphinx-issues-0.1.0.tar.gz (3.4 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page