Commits

Doug Hellmann committed 6b03fb0 Merge

merge sqltable addition with other changes

Comments (0)

Files changed (28)

 996f292392fa41f8fd939afd1a635388859cf8a8 clearquest-0.3
 64dbae18ef8b1590b49b46b48bce933cf18d38e7 clearquest-0.4
 3a43dd5c95e9a19ed40ac332f302e9fd55e94987 epydoc-0.5
+5c74ab0760468e9da3bac15d91a2bbc198142dac programoutput-0.6
 epydoc:
    Sebastian Wiesner <lunaryorn@googlemail.com>
 
-pyqt4:
-   Sebastian Wiesner <lunaryorn@googlemail.com>
-
 doxylink
    Matt Williams <matt@milliams.com>
 
    Andrey Mikhaylenko <neithere@gmail.com>
 
 hyphenator:
-   Björn Müller <diehose@freenet.de> 
+   Björn Müller <diehose@freenet.de>
 
 youtube:
    Chris Pickel <sfiera@gmail.com>
 - paverutils: an alternate integration of Sphinx with Paver_.
 - plantuml: embed UML diagram by using PlantUML_
 - programoutput: include output of programs into documentation
-- pyqt4: markup for PyQt4 signals
 - requirements: declare requirements wherever you need (e.g. in test
-  docstrings), mark statuses and collect them in a single list 
+  docstrings), mark statuses and collect them in a single list
 - rubydomain: an extension for Ruby support (Sphinx 1.0 needed)
 - sadisplay: display SqlAlchemy model sadisplay_
-- sdedit: an extension inserting sequence diagram by using Quick Sequence. 
+- sdedit: an extension inserting sequence diagram by using Quick Sequence.
   Diagram Editor (sdedit_)
 - seqdiag: embed sequence diagrams by using seqdiag_
 - spelling: Spelling checker using PyEnchant_

issuetracker/CHANGES.rst

+0.10 (in development)
+=====================
+
+- Use requests library for HTTP requests
+
+
 0.9 (Aug 31, 2011)
 ==================
 

issuetracker/setup.py

 # -*- coding: utf-8 -*-
-# Copyright (c) 2011, Sebastian Wiesner <lunaryorn@googlemail.com>
+# Copyright (c) 2011, 2012, Sebastian Wiesner <lunaryorn@googlemail.com>
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
     platforms='any',
     packages=find_packages(),
     include_package_data=True,
-    install_requires=['Sphinx>=1.0.7'],
+    install_requires=['Sphinx>=1.0.7', 'requests>=0.9'],
     namespace_packages=['sphinxcontrib'],
 )

issuetracker/sphinxcontrib/issuetracker.py

                         absolute_import)
 
 
-__version__ = '0.9'
+__version__ = '0.10'
 
 import re
-import urllib2
+import json
+from os import path
 from contextlib import closing
 from collections import namedtuple
-from os import path
+from xml.etree import ElementTree as etree
 
+import requests
 from docutils import nodes
 from docutils.transforms import Transform
 from sphinx.roles import XRefRole
         return cls(project, url)
 
 
-def fetch_issue(app, url, output_format=None, opener=None):
+FORMAT_CALLBACKS = {
+    'json': json.loads,
+    'xml': etree.fromstring,
+    None: lambda x: x,
+}
+
+
+def fetch_issue(app, url, output_format=None):
     """
     Fetch issue data from a web service or website.
 
     ``app`` is the sphinx application object.  ``url`` is the url of the issue.
     ``output_format`` is the format of the data retrieved from the given
-    ``url``.  If set, it must be either ``'json'`` or ``'xml'``.  ``opener`` is
-    a :class:`urllib2.OpenerDirectory` object used to open the url.  If
-    ``None``, the global opener is used.
+    ``url``.  If set, it must be either ``'json'`` or ``'xml'``.
 
     Return the raw data retrieved from url, if ``output_format`` is unset.  If
     ``output_format`` is ``'xml'``, return a ElementTree document.  If
     (typically a dictionary).  Return ``None``, if ``url`` returned a status
     code other than 200.
     """
-    if output_format not in ('json', 'xml'):
+    if output_format not in FORMAT_CALLBACKS:
         raise ValueError(output_format)
 
-    if opener:
-        urlopen = opener.open
+    response = requests.get(url)
+    if response.status_code == 200:
+        return FORMAT_CALLBACKS[output_format](response.content)
     else:
-        urlopen = urllib2.urlopen
-
-    try:
-        with closing(urlopen(url)) as response:
-            if output_format == 'json':
-                import json
-                return json.load(response)
-            elif output_format == 'xml':
-                from xml.etree import ElementTree as etree
-                return etree.parse(response)
-            else:
-                return response
-    except urllib2.HTTPError as error:
-        if error.code != 404:
-            # 404 just says that the issue doesn't exist, but anything else is
-            # more serious and deserves a warning
-            app.warn('{0} unavailable with code {1}'.format(url, error.code))
+        if response.status_code != 404:
+            # 404 just says that the issue doesn't exist, but anything else is more
+            # serious and deserves a warning
+            app.warn('{0} unavailable with code {1}'.format(url, response.status_code))
         return None
 
 
 def lookup_jira_issue(app, tracker_config, issue_id):
     if not tracker_config.url:
         raise ValueError('URL required')
-    # protected jira trackers may require cookie processing
-    from cookielib import CookieJar
-    cookies = CookieJar()
-    cookie_opener = urllib2.build_opener(urllib2.HTTPCookieProcessor(cookies))
     issue = fetch_issue(app, JIRA_API_URL.format(tracker_config, issue_id),
-                        output_format='xml', opener=cookie_opener)
+                        output_format='xml')
     if issue:
         project = issue.find('*/item/project').text
         if project != tracker_config.project:

issuetracker/tests/requirements.txt

+requests>=0.9
 sphinx>=1.0.7
 
 launchpadlib

issuetracker/tests/test_builtin_trackers.py

 # -*- coding: utf-8 -*-
-# Copyright (c) 2011, Sebastian Wiesner <lunaryorn@googlemail.com>
+# Copyright (c) 2011, 2012, Sebastian Wiesner <lunaryorn@googlemail.com>
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
     default_tracker_config = TrackerConfig('inkscape')
 
     tracker_config = {'wrong project': TrackerConfig('foo'),
-                      'invalid': TrackerConfig('launchpad')}
+                      'invalid': TrackerConfig('null')}
 
     issues = {
         'closed': Issue('647789', title='tries to install file(s) outside of '

programoutput/CHANGES.rst

+0.6 (in development)
+====================
+
+- Python 3 support
+- Require Sphinx 1.1 now
+
+
 0.5 (Sep 19, 2011)
 ==================
 

programoutput/doc/index.rst

 .. py:module:: sphinxcontrib.programoutput
    :synopsis:  Include the output of programs into documents
 
-Sphinx 1.0 extension to insert the output of arbitrary commands into documents.
+Sphinx_ extension to insert the output of arbitrary commands into documents.
 
 The extension is available under the terms of the BSD license, see LICENSE_
 for more information.
 Installation
 ------------
 
-This extension requires Sphinx_ 1.0 and Python 2.6.  It is available in the
-Python Package Index::
+This extension requires Sphinx_ 1.1 and at least Python 2.6 or Python 3.2.  It
+is available in the Python Package Index::
 
    pip install sphinxcontrib-programoutput
 

programoutput/setup.py

 # -*- coding: utf-8 -*-
-# Copyright (c) 2011, Sebastian Wiesner <lunaryorn@googlemail.com>
+# Copyright (c) 2011, 2012, Sebastian Wiesner <lunaryorn@googlemail.com>
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
     platforms='any',
     packages=find_packages(),
     include_package_data=True,
-    install_requires=['Sphinx>=1.0'],
+    install_requires=['Sphinx>=1.1'],
     namespace_packages=['sphinxcontrib'],
+    use_2to3=True,
 )

programoutput/sphinxcontrib/programoutput.py

 # -*- coding: utf-8 -*-
-# Copyright (c) 2010, 2011, Sebastian Wiesner <lunaryorn@googlemail.com>
+# Copyright (c) 2010, 2011, 2012, Sebastian Wiesner <lunaryorn@googlemail.com>
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
 from docutils.parsers.rst.directives import flag, unchanged, nonnegative_int
 
 
-__version__ = '0.5'
+__version__ = '0.6'
 
 
 class program_output(nodes.Element):
         command.
         """
         # pylint: disable=E1101
-        if isinstance(self.command, unicode):
-            command = self.command.encode(sys.getfilesystemencoding())
+        if self.shell:
+            if sys.version_info[0] < 3 and isinstance(self.command, unicode):
+                command = self.command.encode(sys.getfilesystemencoding())
+            else:
+                command = self.command
         else:
-            command = self.command
-        if isinstance(command, basestring) and not self.shell:
-            command = shlex.split(command)
+            if sys.version_info[0] < 3 and isinstance(self.command, unicode):
+                command = shlex.split(self.command.encode(sys.getfilesystemencoding()))
+            elif isinstance(self.command, str):
+                command = shlex.split(self.command)
+            else:
+                command = self.command
         return Popen(command, shell=self.shell, stdout=PIPE,
                      stderr=PIPE if self.hide_standard_error else STDOUT)
 
                          '$ {command}\n{output}', 'env')
     app.add_directive('program-output', ProgramOutputDirective)
     app.add_directive('command-output', ProgramOutputDirective)
-    app.connect(b'builder-inited', init_cache)
-    app.connect(b'doctree-read', run_programs)
+    app.connect(str('builder-inited'), init_cache)
+    app.connect(str('doctree-read'), run_programs)

programoutput/tests/test_cache.py

 # -*- coding: utf-8 -*-
-# Copyright (c) 2011, Sebastian Wiesner <lunaryorn@googlemail.com>
+# Copyright (c) 2011, 2012, Sebastian Wiesner <lunaryorn@googlemail.com>
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
 
 
 def test_simple(cache):
-    assert_cache(cache, Command(['echo', 'spam']), 'spam')
+    assert_cache(cache, Command(['echo', 'blök']), 'blök')
 
 
 def test_shell(cache):
-    assert_cache(cache, Command('echo spam', shell=True), 'spam')
+    assert_cache(cache, Command('echo blök', shell=True), 'blök')
 
 
 def test_hidden_standard_error(cache):

programoutput/tests/test_directive.py

 # -*- coding: utf-8 -*-
-# Copyright (c) 2011, Sebastian Wiesner <lunaryorn@googlemail.com>
+# Copyright (c) 2011, 2012, Sebastian Wiesner <lunaryorn@googlemail.com>
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
     assert_cache(cache, 'python -V', '', hide_standard_error=True)
 
 
-@pytest.mark.with_content('.. program-output:: echo "${VIRTUAL_ENV}"')
+@pytest.mark.with_content('.. program-output:: echo "${HOME}"')
 def test_no_expansion_without_shell(doctree, cache):
-    assert_output(doctree, '${VIRTUAL_ENV}')
-    assert_cache(cache, 'echo "${VIRTUAL_ENV}"', '${VIRTUAL_ENV}')
+    assert_output(doctree, '${HOME}')
+    assert_cache(cache, 'echo "${HOME}"', '${HOME}')
 
 
 @pytest.mark.with_content("""\
-.. program-output:: echo "${VIRTUAL_ENV}"
+.. program-output:: echo "${HOME}"
    :shell:""")
 def test_expansion_with_shell(doctree, cache):
-    assert_output(doctree, os.environ['VIRTUAL_ENV'])
-    assert_cache(cache, 'echo "${VIRTUAL_ENV}"', os.environ['VIRTUAL_ENV'],
-                 use_shell=True)
+    assert_output(doctree, os.environ['HOME'])
+    assert_cache(cache, 'echo "${HOME}"', os.environ['HOME'], use_shell=True)
 
 
 @pytest.mark.with_content("""\
 @pytest.mark.with_content('''\
 .. program-output:: echo
    :shell:
-   :extraargs: "${VIRTUAL_ENV}"''')
+   :extraargs: "${HOME}"''')
 def test_extraargs_with_shell(doctree, cache):
-    assert_output(doctree, os.environ['VIRTUAL_ENV'])
-    assert_cache(cache, 'echo "${VIRTUAL_ENV}"', os.environ['VIRTUAL_ENV'],
-                 use_shell=True)
+    assert_output(doctree, os.environ['HOME'])
+    assert_cache(cache, 'echo "${HOME}"', os.environ['HOME'], use_shell=True)
 
 
 @pytest.mark.with_content("""\
     srcfile = str(srcdir.join('index.rst'))
     assert message['source'] == srcfile
     assert message['line'] == 1
-    msgtemplate = ("{0}:1: (ERROR/3) Command {1!r} failed: "
-                   "[Errno 2] No such file or directory")
+    if sys.version_info[0] < 3:
+        msgtemplate = ("{0}:1: (ERROR/3) Command {1!r} failed: "
+                       "[Errno 2] No such file or directory")
+    else:
+        msgtemplate = ("{0}:1: (ERROR/3) Command {1!r} failed: "
+                       "[Errno 2] No such file or directory: {1}")
     assert message.astext() == msgtemplate.format(srcfile, "'spam with eggs'")

programoutput/tox.ini

 
 [testenv]
 deps=
-    -r test_requiremens.txt
+    -r{toxinidir}/tests/requirements.txt
 commands=
-    py.test {posargs:--junitxml={envlogdir}/tests.xml}
+    py.test {posargs:--junitxml={envname}-tests.xml}
 
 [testenv:doc]
 deps=

pyqt4/CHANGES.rst

-0.5 (Jul 18, 2010)
-==================
-
-- Renamed :rst:role:`:pyqt4:sig:` role to :rst:role:`:pyqt4:signal:` to
-  improve readability
-- Changed signature prefix to "PyQt4 signal"
-
-
-0.4 (May 21, 2010)
-==================
-
-- Initial release

pyqt4/MANIFEST.in

-include README
-include LICENSE
-include CHANGES.*
-inlcude test_pyqt4.py
-recursive-include doc *.rst *.py Makefile
-prune doc/_build

pyqt4/README

-####################
-sphinxcontrib-pyqt4
-####################
-
-http://packages.python.org/sphinxcontrib-pyqt4
-
-A Sphinx_ extension providing PyQt4-specific markup.
-
-
-Installation
-------------
-
-This extension can be installed from the Python Package Index::
-
-   pip install sphinx-contrib.pyqt4
-
-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/pyqt4
-   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-pyqt4

pyqt4/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-qt4.qhcp"
-	@echo "To view the help file:"
-	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/sphinxcontrib-qt4.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-qt4"
-	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/sphinxcontrib-qt4"
-	@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."

pyqt4/doc/changes.rst

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

pyqt4/doc/conf.py

-# -*- coding: utf-8 -*-
-
-import sys, os
-
-needs_sphinx = '1.0'
-
-extensions = ['sphinx.ext.intersphinx']
-
-source_suffix = '.rst'
-master_doc = 'index'
-
-project = u'sphinxcontrib-qt4'
-copyright = u'2010, Sebastian Wiesner'
-version = '0.5'
-release = '0.5'
-
-exclude_patterns = ['_build/*']
-
-html_theme = 'default'
-html_static_path = []
-
-intersphinx_mapping = {'sphinx': ('http://sphinx.pocoo.org/', None)}

pyqt4/doc/index.rst

-.. highlight:: rest
-.. default-domain:: rst
-
-:py:mod:`sphinxcontrib.pyqt4` -- Document Qt4 APIs
-=====================================================
-
-.. py:module:: sphinxcontribx.pyqt4
-   :synopsis: Special directives for Qt4 APIs
-
-This Sphinx_ 1.0 extension provides markup to document PyQt4_ specific
-objects.  Currently it only supports signals.
-
-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.pyqt4
-
-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/pyqt4
-   python setup.py install
-
-
-Usage
------
-
-This extension provides the ``pyqt4`` domain, which extends the standard
-python domain with the new :dir:`pyqt4:signal` directive:
-
-.. directive:: pyqt4:signal
-
-   This directive documents a signal.  It behaves like the standard
-   :dir:`py:method` directive, except that the resulting markup marks the
-   generated signature a signal.
-
-To reference such a signal, use the equally named role :role:`pyqt4:signal`:
-
-.. role:: pyqt4:signal
-
-   Reference a signal documented with :dir:`pyqt4:signal`
-
-Though the ``pyqt4`` domain is derived from the Python domain and can thus
-work as drop-in replacement for it, you should not use this directive as
-default domain, unless you are documenting a project consisting solely of
-PyQt4 APIs.
-
-As the term "signal" is rather common, other domains may add a directive of
-this name to the python domain, too.  Therefore, it is strongly advisable to
-document signals by using the fully qualified name of the directive.  This
-clearly marks the signal as PyQt4 signal, avoiding any disambiguities.
-
-
-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/
-.. _PyQt4: http://www.riverbankcomputing.co.uk/software/pyqt/intro/
-.. _`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

pyqt4/setup.cfg

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

pyqt4/setup.py

-# -*- coding: utf-8 -*-
-
-from setuptools import setup, find_packages
-
-with open('README') as stream:
-    long_desc = stream.read()
-
-
-requires = ['Sphinx>=1.0b2']
-
-setup(
-    name='sphinxcontrib-pyqt4',
-    version='0.5',
-    url='http://packages.python.org/sphinxcontrib-pyqt4',
-    download_url='http://pypi.python.org/pypi/sphinxcontrib-pyqt4',
-    license='BSD',
-    author='Sebastian Wiesner',
-    author_email='lunaryorn@googlemail.com',
-    description='PyQt4-specific markup for Sphinx',
-    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'],
-)

pyqt4/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__)
-

pyqt4/sphinxcontrib/pyqt4.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.pyqt4
-    ===================
-
-    This extension provides a single directive for the python domain to
-    document PyQt4 signals.
-
-    .. moduleauthor::  Sebastian Wiesner  <lunaryorn@googlemail.com>
-"""
-
-
-from sphinx.locale import l_, _
-from sphinx.domains import ObjType
-from sphinx.domains.python import PythonDomain, PyClassmember, PyXRefRole
-
-
-class PyQt4Signal(PyClassmember):
-    def needs_arglist(self):
-        return True
-
-    def get_signature_prefix(self, sig):
-        return 'PyQt4 signal '
-
-    def get_index_text(self, modname, name_cls):
-        name, cls = name_cls
-        add_modules = self.env.config.add_module_names
-        try:
-            clsname, signame = name.rsplit('.', 1)
-        except ValueError:
-            if modname:
-                return _('%s() (in module %s)') % (name, modname)
-            else:
-                return '%s()' % name
-        if modname and add_modules:
-            return _('%s() (%s.%s signal)') % (
-                signame, modname, clsname)
-        else:
-            return _('%s() (%s signal)') % (signame, clsname)
-
-
-class PyQt4Domain(PythonDomain):
-    name = 'pyqt4'
-    label = 'PyQt4'
-
-    object_types = PythonDomain.object_types.copy()
-    directives = PythonDomain.directives.copy()
-    roles = PythonDomain.roles.copy()
-
-    object_types['signal'] = ObjType(l_('signal'), 'signal', 'obj')
-    directives['signal'] = PyQt4Signal
-    roles['signal'] = PyXRefRole(fix_parens=True)
-
-
-def setup(app):
-    app.add_domain(PyQt4Domain)

pyqt4/test_pyqt4.py

-#!/usr/bin/env python
-# -*- coding: utf-8 -*-
-
-import sphinx.locale
-from mock import Mock
-
-from sphinxcontrib import pyqt4
-
-
-# mock translator to return messages unchanged
-sphinx.locale.translator = Mock()
-sphinx.locale.translator.ugettext = lambda m: m
-
-
-def pytest_funcarg__app(request):
-    return Mock()
-
-
-def pytest_funcarg__env(request):
-    return Mock()
-
-
-def pytest_funcarg__signal(request):
-    env = request.getfuncargvalue('env')
-    state = Mock()
-    state.document.settings.env = env
-    state_machine = Mock()
-    state_machine.get_source_and_line.return_value = (Mock(), Mock())
-    signal = pyqt4.PyQt4Signal('signal', [], {}, [], 1, 1, '', state,
-                               state_machine)
-    signal.env = env
-    return signal
-
-
-def test_signal_needs_arglist(signal):
-    assert signal.needs_arglist()
-
-
-def test_signal_get_signature_prefix(signal):
-    assert signal.get_signature_prefix('') == 'PyQt4 signal '
-    assert signal.get_signature_prefix('foo') == 'PyQt4 signal '
-
-
-def test_signal_get_index_text_with(signal, env):
-    env.config.add_module_names = True
-    assert signal.get_index_text('', ('say', None)) == \
-           'say()'
-    assert signal.get_index_text('hello', ('say', None)) == \
-           'say() (in module hello)'
-    assert signal.get_index_text('', ('World.say', None)) == \
-           'say() (World signal)'
-    assert signal.get_index_text('', ('World.say', None)) == \
-           'say() (World signal)'
-    env.config.add_module_names = False
-    assert signal.get_index_text('', ('say', None)) == \
-           'say()'
-    assert signal.get_index_text('hello', ('say', None)) == \
-           'say() (in module hello)'
-    assert signal.get_index_text('', ('World.say', None)) == \
-           'say() (World signal)'
-    assert signal.get_index_text('', ('World.say', None)) == \
-           'say() (World signal)'
-
-
-def test_domain_attributes():
-    domain = pyqt4.PyQt4Domain
-    assert domain.name == 'pyqt4'
-    assert domain.label == 'PyQt4'
-    assert 'signal' in domain.object_types
-    assert domain.directives['signal'] is pyqt4.PyQt4Signal
-    assert 'signal' in domain.roles
-    # make sure, that we copied attributes from base class
-    base = domain.__bases__[0]
-    assert 'signal' not in base.object_types
-    assert 'signal' not in base.directives
-    assert 'signal' not in base.roles
-
-
-def test_setup(app):
-    pyqt4.setup(app)
-    assert app.add_domain.called
-    app.add_domain.assert_called_with(pyqt4.PyQt4Domain)
-
-
-def main():
-    import py
-    py.cmdline.pytest()
-
-
-if __name__ == '__main__':
-    main()

pyqt4/tox.ini

-[tox]
-envlist=python,doc
-
-[testenv:python]
-deps=
-    mock
-    pytest
-commands=
-    py.test --junitxml={envlogdir}/tests.xml []
-
-[testenv:doc]
-deps=
-    sphinx
-commands=
-    sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees doc {envtmpdir}/linkcheck
-    sphinx-build -W -b html -d {envtmpdir}/doctrees doc {envtmpdir}/html