Skip to content

Commit 519dace

Browse files
committed
Avoid a warning when building the docs.
1 parent cfd1dfa commit 519dace

File tree

2 files changed

+5
-0
lines changed

2 files changed

+5
-0
lines changed

docs/conf.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,8 @@
5050
("py:meth", "protocol.WebSocketCommonProtocol.connection_lost"),
5151
("py:meth", "protocol.WebSocketCommonProtocol.read_message"),
5252
("py:meth", "protocol.WebSocketCommonProtocol.write_frame"),
53+
# Caused by https://github.com/sphinx-doc/sphinx/issues/13838
54+
("py:class", "ssl_module.SSLContext"),
5355
]
5456

5557
# Add any Sphinx extension module names here, as strings. They can be

src/websockets/trio/client.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -233,6 +233,9 @@ class connect:
233233
234234
"""
235235

236+
# Arguments of type SSLContext don't render correctly in the documentation
237+
# because of https://github.com/sphinx-doc/sphinx/issues/13838.
238+
236239
def __init__(
237240
self,
238241
uri: str,

0 commit comments

Comments
 (0)