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.
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
This extension provides the pyqt4 domain, which extends the standard python domain with the new pyqt4:signal directive:
This directive documents a signal. It behaves like the standard py:method directive, except that the resulting markup marks the generated signature a signal.
To reference such a signal, use the equally named role pyqt4:signal:
Reference a signal documented with 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.
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!