Sebastian Wiesner avatar Sebastian Wiesner committed 9b3ab04

Document the pyqt4:signal role

Comments (0)

Files changed (1)

pyqt4/doc/index.rst

    :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
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.