Change formatting of 'None'. (#154)

None is now a link to the builtin "None".

Author: domdfcoding

sphinx_autodoc_typehints.py

@@ -98,7 +98,7 @@ def get_annotation_args(annotation, module: str, class_name: str) -> Tuple:
 def format_annotation(annotation, fully_qualified: bool = False) -> str:
     # Special cases
     if annotation is None or annotation is type(None):  # noqa: E721
-        return '``None``'
+        return ':py:obj:`None`'
     elif annotation is Ellipsis:
         return '...'
 

tests/test_sphinx_autodoc_typehints.py

@@ -98,7 +98,7 @@ def test_parse_annotation(annotation, module, class_name, args):
 @pytest.mark.parametrize('annotation, expected_result', [
     (str,                           ':py:class:`str`'),
     (int,                           ':py:class:`int`'),
-    (type(None),                    '``None``'),
+    (type(None),                    ':py:obj:`None`'),
     (type,                          ':py:class:`type`'),
     (Type,                          ':py:class:`~typing.Type`'),
     (Type[A],                       ':py:class:`~typing.Type`\\[:py:class:`~%s.A`]' % __name__),
@@ -138,7 +138,7 @@ def test_parse_annotation(annotation, module, class_name, args):
     (Callable[[int, str], bool],    ':py:data:`~typing.Callable`\\[\\[:py:class:`int`, '
                                     ':py:class:`str`], :py:class:`bool`]'),
     (Callable[[int, str], None],    ':py:data:`~typing.Callable`\\[\\[:py:class:`int`, '
-                                    ':py:class:`str`], ``None``]'),
+                                    ':py:class:`str`], :py:obj:`None`]'),
     (Callable[[T], T],              ':py:data:`~typing.Callable`\\[\\[\\~T], \\~T]'),
     (Pattern,                       ':py:class:`~typing.Pattern`'),
     (Pattern[str],                  ':py:class:`~typing.Pattern`\\[:py:class:`str`]'),