sphinx-contrib / issuetracker / README

##########################
sphinxcontrib-issuetracker
##########################

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

This Sphinx_ 1.0 extension parses textual issue references like ``#10`` and
turns these into references into 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>`_

Furthermore this extension provides a simple API to add other issue
trackers.


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
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.