Source

sphinx-contrib / issuetracker /

The default branch has multiple heads

Filename Size Date modified Message
..
doc
sphinxcontrib
tests
3.7 KB
518 B
1.4 KB
209 B
1.4 KB
127 B
2.8 KB
372 B
##########################
sphinxcontrib-issuetracker
##########################

http://packages.python.org/sphinxcontrib-issuetracker

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:

- `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