Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -191,3 +191,4 @@ usecase-driven documentation, see :ref:`get-started` or :ref:`user-guides`.
glossary
changes/index
examples

38 changes: 36 additions & 2 deletions sphinx/domains/python/_object.py
Original file line number Diff line number Diff line change
Expand Up @@ -151,15 +151,49 @@ def make_xrefs(


class PyField(PyXrefMixin, Field):
pass
def make_xref(
self,
rolename: str,
domain: str,
target: str,
innernode: type[TextlikeNode] = nodes.emphasis,
contnode: Node | None = None,
env: BuildEnvironment | None = None,
inliner: Inliner | None = None,
location: Node | None = None,
) -> Node:
if rolename == 'class' and target == 'None':
# None is not a type, so use obj role instead.
rolename = 'obj'

return super().make_xref(
rolename, domain, target, innernode, contnode, env, inliner, location
)


class PyGroupedField(PyXrefMixin, GroupedField):
pass


class PyTypedField(PyXrefMixin, TypedField):
pass
def make_xref(
self,
rolename: str,
domain: str,
target: str,
innernode: type[TextlikeNode] = nodes.emphasis,
contnode: Node | None = None,
env: BuildEnvironment | None = None,
inliner: Inliner | None = None,
location: Node | None = None,
) -> Node:
if rolename == 'class' and target == 'None':
# None is not a type, so use obj role instead.
rolename = 'obj'

return super().make_xref(
rolename, domain, target, innernode, contnode, env, inliner, location
)


class PyObject(ObjectDescription[tuple[str, str]]):
Expand Down
1 change: 1 addition & 0 deletions sphinx/util/typing.py
Original file line number Diff line number Diff line change
Expand Up @@ -261,6 +261,7 @@ def restify(cls: Any, mode: _RestifyMode = 'fully-qualified-except-typing') -> s
# things that are not types
if cls is None or cls == types.NoneType:
return ':py:obj:`None`'

if cls is Ellipsis:
return '...'
if isinstance(cls, str):
Expand Down
Loading