Skip to content

Commit 5209a29

Browse files
committed
Fix pyqt signal docstring
1 parent fd0efb7 commit 5209a29

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

docs/source/conf.py

+11
Original file line numberDiff line numberDiff line change
@@ -297,3 +297,14 @@
297297

298298
# Example configuration for intersphinx: refer to the Python standard library.
299299
intersphinx_mapping = {'python': ('https://docs.python.org/3', None)}
300+
301+
302+
def fix_pyqtsignal_docstring(app, what, name, obj, options, lines):
303+
from AnyQt.QtCore import pyqtSignal as Signal
304+
if isinstance(obj, Signal):
305+
for i in range(len(lines)):
306+
lines[i] = lines[i].replace("*", r"\*")
307+
308+
309+
def setup(app):
310+
app.connect("autodoc-process-docstring", fix_pyqtsignal_docstring)

0 commit comments

Comments
 (0)