Commits

Sebastian Wiesner committed 16737d7

Initial import of the issuetracker extension

  • Participants
  • Parent commits 1bc7191
  • Tags issuetracker-0.4

Comments (0)

Files changed (13)

 
 googleanalytics:
    Domen Kožar <domen@dev.si>
+
+issuetracker:
+   Sebastian Wiesner <lunaryorn@googlemail.com>
 - osaka: convert standard Japanese doc to Osaka dialect (it is joke extension)
 - rubydomain: an extension for Ruby support (Sphinx 1.0 needed)
 - zopeext: provide an ``autointerface`` directive for using Zope interfaces.
-- googleanalytics: track html visitors statistics 
+- googleanalytics: track html visitors statistics
 - traclinks: create TracLinks_ to a Trac_ instance from within Sphinx
+- issuetracker: link to different issue trackers
 
 .. _aafigure: http://docutils.sourceforge.net/sandbox/aafigure/
 

issuetracker/CHANGES.rst

+0.4 (May 21, 2010)
+==================
+
+- Misc spelling fixes
+
+0.3 (May 02, 2010)
+==================
+
+- Added support for Google Code
+- Added support for Launchpad
+- Issue tracker callbacks get the build environment now
+
+
+0.2 (Apr 13, 2010)
+==================
+
+- Use ``missing-reference`` event instead of custom event
+
+
+0.1 (Apr 10, 2010)
+==================
+
+- Initial release
+

issuetracker/MANIFEST.in

+include README
+include LICENSE
+include CHANGES.*

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 <http://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

issuetracker/doc/Makefile

+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = _build
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+	-rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/sphinxcontrib-issuetracker.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/sphinxcontrib-issuetracker.qhc"
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/sphinxcontrib-issuetracker"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/sphinxcontrib-issuetracker"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	make -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."

issuetracker/doc/changes.rst

+#########
+Changelog
+#########
+
+.. include:: ../CHANGES.rst

issuetracker/doc/conf.py

+# -*- coding: utf-8 -*-
+#
+# sphinxcontrib-issuetracker documentation build configuration file, created by
+# sphinx-quickstart on Sun Jul 11 15:28:12 2010.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys, os
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#sys.path.insert(0, os.path.abspath('.'))
+
+# -- General configuration -----------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'sphinxcontrib-issuetracker'
+copyright = u'2010, Sebastian Wiesner'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '0.4'
+# The full version, including alpha/beta/rc tags.
+release = '0.4'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = 'default'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = ''
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'sphinxcontrib-issuetrackerdoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+# The paper size ('letter' or 'a4').
+#latex_paper_size = 'letter'
+
+# The font size ('10pt', '11pt' or '12pt').
+#latex_font_size = '10pt'
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+  ('index', 'sphinxcontrib-issuetracker.tex', u'sphinxcontrib-issuetracker Documentation',
+   u'Sebastian Wiesner', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Additional stuff for the LaTeX preamble.
+#latex_preamble = ''
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'sphinxcontrib-issuetracker', u'sphinxcontrib-issuetracker Documentation',
+     [u'Sebastian Wiesner'], 1)
+]
+
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {'http://docs.python.org/': None,
+                       'http://sphinx.pocoo.org/latest/': None,}
+
+
+def setup(app):
+    app.add_description_unit('confval', 'confval',
+                             'pair: %s; configuration value')

issuetracker/doc/index.rst

+:mod:`sphinxcontrib.issuetracker` -- Reference issues in issue trackers
+========================================================================
+
+.. module:: sphinxcontrib.issuetracker
+   :synopsis: Parse issue references and link to the corresponding issues
+
+This extension for Sphinx_ 1.0 parses textual issue references like ``#10``,
+looks up the issue in the configured issue tracker, and includes a link to
+the issue.
+
+The extension is available under the terms of the BSD license, see LICENSE_
+for more information.
+
+
+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
+
+
+Configuration
+-------------
+
+Add ``sphinxcontrib.issuetracker`` to the configuration value
+:confval:`extensions` to enable this extensions and configure the extension:
+
+.. confval:: issuetracker
+
+   The issuetracker to use.  As of now, the following trackers are
+   supported:
+
+   - ``github``: The issue tracker of http://github.com.  To use this issue
+     tracker, either Python 2.6 or later must be used, or simplejson_ must
+     be installed.
+   - ``bitbucket``: The issue tracker of http://bitbucket.org.  To use this
+     issue tracker, `lxml`_ 2.0 or newer must be installed.
+   - ``launchpad``: The issue tracker of http://launchpad.net.  To use this
+     issue tracker, launchpadlib_ must be installed.
+   - ``google code``: The issue tracker of http://code.google.com.  To use
+     this issue tracker, Python 2.5 or newer is required.
+
+.. confval:: issuetracker_project
+
+   The project inside the issue tracker or the project, to which the issue
+   tracker belongs.  Defaults to the value of :confval:`project`.
+
+.. confval:: issuetracker_user
+
+   The user account, to which the project belongs.  Required by the
+   following issue trackers:
+
+   - ``github``
+   - ``bitbucket``
+
+   Can be left empty, if another issue trackers is used.
+
+For instance, with the following configuration issue references in the
+documentation would refer to the `Sphinx issue tracker`_:
+
+.. code-block:: python
+
+   issuetracker = 'bitbucket'
+   issuetracker_user = 'birkenfeld'
+   issuetracker_project = 'sphinx'
+
+By default the extension looks for issue references starting with a single
+dash, like ``#10``.  You can however change the pattern, which is used to
+find issue references:
+
+.. confval:: issuetracker_issue_pattern
+
+   A regular expression, which is used to find and parse issue references.
+   Defaults to ``r'#(\d+)'``.  If changed to ``r'gh-(\d+)'`` for instance,
+   this extension would not longer recognize references like ``#10``, but
+   instead parse references like ``gh-10``.  The pattern must contain only a
+   single group, which matches the issue id.
+
+
+Customization
+-------------
+
+If you use an issue tracker, that is not supported by this extension, then
+set :confval:`issuetracker` to ``None`` or leave it unset, and create your
+own callback for the ``missing-reference`` event of Sphinx.  This callback
+should handle all nodes whose ``reftype`` attribute is ``'issue'``, and
+return ``None`` for all other nodes.  For nodes whose ``reftype`` is
+``'issue'`` the issue id is available in the ``reftarget`` attribute.
+
+You may want to use the following convenience function.  It creates a
+callback that does all the node handling for you.  You only have to provide
+a function, which returns metadata for the given issue id:
+
+.. autofunction:: make_issue_reference_resolver
+
+
+Contribution
+------------
+
+Please contact the author or create an issue in the issue tracker of the
+sphinx-contrib_ repository, if you have found any bugs or miss some
+functionality (e.g. integration of some other issue tracker).  Patches are
+welcome!
+
+
+.. toctree::
+   :maxdepth: 2
+   :hidden:
+
+   changes.rst
+
+
+.. _`Sphinx`: http://sphinx.pocoo.org/latest
+.. _`Sphinx issue tracker`: http://bitbucket.org/birkenfeld/sphinx/issues/
+.. _`lxml`: http://codespeak.net/lxml
+.. _`simplejson`: http://pypi.python.org/pypi/simplejson/
+.. _`launchpadlib`: http://pypi.python.org/pypi/launchpadlib/
+.. _`sphinx-contrib`: http://bitbucket.org/birkenfeld/sphinx-contrib
+.. _`issue tracker`: http://bitbucket.org/birkenfeld/sphinx-contrib/issues
+.. _LICENSE: http://bitbucket.org/birkenfeld/sphinx-contrib/src/tip/LICENSE

issuetracker/setup.cfg

+[egg_info]
+tag_build = dev
+tag_date = true
+
+[aliases]
+release = egg_info -RDb ''

issuetracker/setup.py

+# -*- coding: utf-8 -*-
+
+import os
+from setuptools import setup, find_packages
+
+
+with open('README') as stream:
+    long_desc = stream.read()
+
+
+requires = ['Sphinx>=1.0b2']
+
+setup(
+    name='sphinxcontrib-issuetracker',
+    version='0.4',
+    url='http://packages.python.org/sphinxcontrib-issuetracker',
+    download_url='http://pypi.python.org/pypi/sphinxcontrib-issuetracker',
+    license='BSD',
+    author='Sebastian Wiesner',
+    author_email='lunaryorn@googlemail.com',
+    description='Sphinx integration with different issuetrackers',
+    long_description=long_desc,
+    zip_safe=False,
+    classifiers=[
+        'Development Status :: 4 - Beta',
+        'Environment :: Console',
+        'Environment :: Web Environment',
+        'Intended Audience :: Developers',
+        'License :: OSI Approved :: BSD License',
+        'Operating System :: OS Independent',
+        'Programming Language :: Python',
+        'Topic :: Documentation',
+        'Topic :: Utilities',
+    ],
+    platforms='any',
+    packages=find_packages(),
+    include_package_data=True,
+    install_requires=requires,
+    namespace_packages=['sphinxcontrib'],
+)

issuetracker/sphinxcontrib/__init__.py

+# -*- coding: utf-8 -*-
+"""
+    sphinxcontrib
+    ~~~~~~~~~~~~~
+
+    This package is a namespace package that contains all extensions
+    distributed in the ``sphinx-contrib`` distribution.
+
+    :copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
+    :license: BSD, see LICENSE for details.
+"""
+
+__import__('pkg_resources').declare_namespace(__name__)
+

issuetracker/sphinxcontrib/issuetracker.py

+# -*- coding: utf-8 -*-
+# Copyright (c) 2010, Sebastian Wiesner <lunaryorn@googlemail.com>
+# All rights reserved.
+
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+
+# 1. Redistributions of source code must retain the above copyright notice,
+#    this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright
+#    notice, this list of conditions and the following disclaimer in the
+#    documentation and/or other materials provided with the distribution.
+
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+
+
+
+"""
+    sphinxcontrib.issuetracker
+    ==========================
+
+    Integration with isse trackers.
+
+    Replace textual issue references (like #1) with a real reference to the
+    corresponding issue on bitbucket.
+
+    .. moduleauthor::  Sebastian Wiesner  <lunaryorn@googlemail.com>
+"""
+
+
+import re
+import urllib
+from contextlib import closing
+from functools import partial
+
+from docutils import nodes
+from docutils.transforms import Transform
+from sphinx.addnodes import pending_xref
+
+
+GITHUB_URL = 'http://github.com/%(user)s/%(project)s/issues/%(issue_id)s'
+BITBUCKET_URL = ('http://bitbucket.org/%(user)s/%(project)s/issue/'
+                 '%(issue_id)s/')
+
+
+def get_github_issue_information(project, user, issue_id, env):
+    try:
+        import json
+    except ImportError:
+        import simplejson as json
+
+    show_issue = ('http://github.com/api/v2/json/issues/show/'
+                  '%(user)s/%(project)s/%(issue_id)s' % locals())
+
+    with closing(urllib.urlopen(show_issue)) as response:
+        response = json.load(response)
+    if 'error' in response:
+        return None
+
+    info = response['issue']
+    info['closed'] = info['state'] == 'closed'
+    info['uri'] = GITHUB_URL % locals()
+    return info
+
+
+def get_bitbucket_issue_information(project, user, issue_id, env):
+    from lxml.html import parse
+
+    uri = BITBUCKET_URL % locals()
+    with closing(urllib.urlopen(uri)) as response:
+        if response.getcode() == 404:
+            # issue didn't exist
+            return None
+        tree = parse(response)
+    info = tree.getroot().cssselect('.issues-issue-infotable')[0]
+    is_new = info.cssselect('.issue-status-new')
+    is_open = info.cssselect('.issue-stats-open')
+    return {'uri': uri, 'closed': not (is_open or is_new)}
+
+
+def get_launchpad_issue_information(project, user, issue_id, env):
+    launchpad = getattr(env, 'issuetracker_launchpad', None)
+    if not launchpad:
+        from launchpadlib.launchpad import Launchpad
+        launchpad = Launchpad.login_anonymously(
+            'lunar.sphinx.ext.issuetracker', service_root='production')
+        env.issuetracker_launchpad = launchpad
+    try:
+        # get the bug
+        bug = launchpad.bugs[issue_id]
+    except KeyError:
+        return None
+
+    for task in bug.bug_tasks:
+        if task.bug_target_name == project:
+            break
+    else:
+        # no matching task found
+        return None
+
+    uri = 'https://bugs.launchpad.net/bugs/%s' % issue_id
+    # if date_closed exists, we consider the bug as closed
+    return {'uri': uri, 'closed': bool(task.date_closed)}
+
+
+def get_google_code_issue_information(project, user, issue_id, env):
+    from xml.etree import cElementTree as etree
+
+    show_issue = ('http://code.google.com/feeds/issues/p/'
+                  '%(project)s/issues/full/%(issue_id)s' % locals())
+    with closing(urllib.urlopen(show_issue)) as response:
+        if response.getcode() == 404:
+            return None
+        tree = etree.parse(response)
+
+    state = tree.find(
+        '{http://schemas.google.com/projecthosting/issues/2009}state')
+    uri = 'http://code.google.com/p/html5lib/issues/detail?id=%s' % issue_id
+    return {'uri': uri, 'closed': state and state.text == 'closed'}
+
+
+def make_issue_reference_resolver(get_issue_information):
+    """
+    Create and return a function which serves as callback for the
+    ``missing-reference`` event, and handles all pending references whose
+    ``reftype`` is ``'issue'``.
+
+    If invoked, the function created by this function returns a reference
+    node which points to the issue, or ``None`` if the issue reference could
+    not be resolved.
+
+    ``get_issue_information`` must be a callable, accepting the follwing
+    four arguments:
+
+    1. The issue tracker project as given to :confval:`issuetracker_project`
+    2. The issue tracker user name as given to :confval:`issuetracker_user`
+    3. The issue id
+    4. The sphinx build environment
+
+    It shall return a dictionary, which may contain the following items:
+
+    - ``'uri'``: The uri to a website representing the issue.  If missing,
+      the created function returns ``None`` to indicate that it can't
+      resolve this issue.
+    - ``'closed'``: If present and ``True``, mark the issue as closed by
+      adding the class ``issue-closed`` to the returned reference.
+    """
+    def resolver(app, env, node, contnode):
+        if node['reftype'] != 'issue':
+            return
+        info = get_issue_information(
+            app.config.issuetracker_project or app.config.project,
+            app.config.issuetracker_user, node['reftarget'], env)
+        if info is None:
+            return None
+        uri = info.get('uri')
+        if not uri:
+            return None
+        reference = nodes.reference()
+        reference['refuri'] = uri
+        if info.get('closed'):
+            reference['classes'].append('issue-closed')
+        reference['classes'].append('reference-issue')
+        reference.append(contnode)
+        return reference
+    return resolver
+
+
+BUILTIN_ISSUE_TRACKERS = {
+    'github': make_issue_reference_resolver(get_github_issue_information),
+    'bitbucket': make_issue_reference_resolver(
+        get_bitbucket_issue_information),
+    'launchpad': make_issue_reference_resolver(
+        get_launchpad_issue_information),
+    'google code': make_issue_reference_resolver(
+        get_google_code_issue_information),
+    }
+
+
+
+class issue_reference(nodes.reference):
+    """
+    A reference to an issue in an issue tracker.
+
+    This node always has the ``issue_id`` attribute, which contains the ID
+    of the referenced issue.
+    """
+    pass
+
+
+class IssuesReferences(Transform):
+    """
+    Transform plain text issue numbers (e.g. #10) into
+    :class:`issue_reference` nodes.
+    """
+
+    default_priority = 999
+
+    def apply(self):
+        config = self.document.settings.env.config
+        issue_pattern = config.issuetracker_issue_pattern
+        if isinstance(issue_pattern, basestring):
+            issue_pattern = re.compile(issue_pattern)
+        for node in self.document.traverse(nodes.Text):
+            text = unicode(node)
+            parent = node.parent
+            new_nodes = []
+            last_issue_ref_end = 0
+            for match in issue_pattern.finditer(text):
+                # extract the text between the last issue reference and the
+                # current issue reference and put it into a new text node
+                head = text[last_issue_ref_end:match.start()]
+                if head:
+                    new_nodes.append(nodes.Text(head))
+                # adjust the position of the last issue reference in the
+                # text
+                last_issue_ref_end = match.end()
+                # extract the issue text (including the leading dash)
+                issuetext = match.group(0)
+                # extract the issue number (excluding the leading dash)
+                issue_id = match.group(1)
+                # turn the issue reference into a reference node
+                refnode = pending_xref()
+                refnode['reftarget'] = issue_id
+                refnode['reftype'] = 'issue'
+                refnode.append(nodes.Text(issuetext))
+                new_nodes.append(refnode)
+            if not new_nodes:
+                # no issue references were found, move on to the next node
+                continue
+            # extract the remaining text after the last issue reference, and
+            # put it into a text node
+            tail = text[last_issue_ref_end:]
+            if tail:
+                new_nodes.append(nodes.Text(tail))
+            # find and remove the original node, and insert all new nodes
+            # instead
+            parent.replace(node, new_nodes)
+
+
+def auto_connect_builtin_issue_resolvers(app):
+    if app.config.issuetracker:
+        app.connect('missing-reference',
+                    BUILTIN_ISSUE_TRACKERS[app.config.issuetracker.lower()])
+
+
+def setup(app):
+    app.add_transform(IssuesReferences)
+    app.connect('builder-inited', auto_connect_builtin_issue_resolvers)
+    app.add_config_value('issuetracker_issue_pattern',
+                         re.compile('#(\d+)'), 'env')
+    app.add_config_value('issuetracker_user', None, 'env')
+    app.add_config_value('issuetracker_project', None, 'env')
+    app.add_config_value('issuetracker', None, 'env')