1. Georg Brandl
  2. sphinx-contrib

Commits

Sebastian Wiesner  committed 9b3ab04

Document the pyqt4:signal role

  • Participants
  • Parent commits a1207fd
  • Branches default

Comments (0)

Files changed (1)

File pyqt4/doc/index.rst

View file
  • Ignore whitespace
    :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