Skip to content

Commit 1a38f5a

Browse files
committed
Document research on removing a workaround.
1 parent 99431ee commit 1a38f5a

2 files changed

Lines changed: 7 additions & 1 deletion

File tree

docs/conf.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,9 @@
7878

7979
autodoc_typehints_description_target = "documented"
8080

81-
# Workaround for https://github.com/sphinx-doc/sphinx/issues/9560
81+
# Workaround for https://github.com/sphinx-doc/sphinx/issues/9560 (fixed)
82+
# but still needed due to https://github.com/sphinx-doc/sphinx/pull/14171
83+
# See reference/types.rst for details.
8284
from sphinx.domains.python import PythonDomain # noqa: E402
8385

8486

docs/reference/types.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
Types
22
=====
33

4+
.. Switch to autotype once https://github.com/sphinx-doc/sphinx/pull/14171
5+
.. is merged; or after dropping support for Python < 3.12 and switching to
6+
.. the type statement.
7+
48
.. automodule:: websockets.typing
59

610
.. autodata:: Data

0 commit comments

Comments
 (0)