1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
|
##########################
sphinxcontrib-issuetracker
##########################
http://packages.python.org/sphinxcontrib-issuetracker
A Sphinx_ extension to turn textual issue ids like ``#10`` into real references
to these issues in an issue tracker.
Currently the following issue trackers are supported:
- `GitHub <http//github.com>`_
- `BitBucket <http://bitbucket.org>`_
- `Launchpad <https://launchpad.net>`_
- `Google Code <http://code.google.com>`_
- `Debian BTS <http://bugs.debian.org>`_
- `Jira <http://www.atlassian.com/software/jira/>`_
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 sphinx-contrib.issuetracker
Alternatively, you can clone the sphinx-contrib_ repository from BitBucket,
and install the extension directly from the repository::
hg clone http://bitbucket.org/birkenfeld/sphinx-contrib
cd sphinx-contrib/issuetracker
python setup.py install
Usage
-----
Please refer to the documentation_ for further information.
.. _Sphinx: http://sphinx.pocoo.org/latest
.. _sphinx-contrib: http://bitbucket.org/birkenfeld/sphinx-contrib
.. _documentation: http://packages.python.org/sphinxcontrib-issuetracker
|
