Metadata-Version: 1.1
Name: sphinx-issues
Version: 0.1.0
Summary: A Sphinx extension for linking to your project's issue tracker
Home-page: https://github.com/sloria/sphinx-issues
Author: Steven Loria
Author-email: sloria1@gmail.com
License: Copyright 2014 Steven Loria

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
Description: =============
        sphinx-issues
        =============
        
        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``.
        
        .. code-block:: python
        
            # 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:
        
        .. code-block:: rst
        
            See issue :issue:`42`
        
            See issues :issue:`12,13`
        
        Credits
        -------
        
        Credit goes to Jeff Forcier for his work on the `releases <https://github.com/bitprophet/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 <https://github.com/sloria/sphinx-issues/blob/master/LICENSE>`_ file for more details.
        
        
        Changelog
        ---------
        
        0.1.0
        -----
        
        - Initial release.
        
Keywords: sphinx,issues,github
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Topic :: Software Development :: Documentation
