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.
Release history Release notifications | RSS feed
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.1.0.tar.gz
(3.4 kB
view hashes)
Built Distribution
Close
Hashes for sphinx_issues-0.1.0-py2.py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d95e36ae94ffbaf0347e20f2a291dd2659420636d1392b364970355ad2c5fb5b |
|
| MD5 | a6c7031229416dfcef150174242435cc |
|
| BLAKE2b-256 | fd9264748b4065c4e26e6fa091184b713e0c0cc304ceb186d9038938cf6a9359 |
