Handle aliases as Documentables

README.rst

@@ -182,7 +182,7 @@ pydoctor 22.7.0
 * Improve the extensibility of pydoctor (`more infos on extensions <https://pydoctor.readthedocs.io/en/latest/customize.html#use-a-custom-system-class>`_)
 * Fix line numbers in reStructuredText xref warnings.
 * Add support for `twisted.python.deprecated` (this was originally part of Twisted's customizations).
-* Add support for re-exporting it names imported from a wildcard import.
+* Add support for re-exporting names imported from a wildcard import.
 
 pydoctor 22.5.1
 ^^^^^^^^^^^^^^^

docs/epytext_demo/demo_epytext_module.py

@@ -6,7 +6,7 @@
 
 from abc import ABC
 import math
-from typing import overload, AnyStr, Dict, Generator, List, Union, Callable, Tuple, TYPE_CHECKING
+from typing import overload, AnyStr, Dict, Generator, List, Union, Callable, Tuple, Sequence, Optional, Protocol, TYPE_CHECKING
 from somelib import SomeInterface
 import zope.interface
 import zope.schema
@@ -32,6 +32,9 @@
 This is also a constant, but annotated with typing.Final.
 """
 
+Interface = Protocol
+"""Aliases are also documented."""
+
 @deprecated(Version("demo", "NEXT", 0, 0), replacement=math.prod)
 def demo_product_deprecated(x, y) -> float: # type: ignore
  return float(x * y)

docs/restructuredtext_demo/demo_restructuredtext_module.py

@@ -8,7 +8,7 @@
 import math
 import zope.interface
 import zope.schema
-from typing import overload, Callable, Sequence, Optional, AnyStr, Generator, Union, List, Dict, TYPE_CHECKING
+from typing import overload, Protocol, Callable, Sequence, Optional, AnyStr, Generator, Union, List, Dict, TYPE_CHECKING
 from incremental import Version
 from twisted.python.deprecate import deprecated, deprecatedProperty
 
@@ -30,6 +30,9 @@
 This is also a constant, but annotated with typing.Final.
 """
 
+Interface = Protocol
+"""Aliases are also documented."""
+
 @deprecated(Version("demo", "NEXT", 0, 0), replacement=math.prod)
 def demo_product_deprecated(x, y) -> float: # type: ignore
  return float(x * y)
@@ -145,6 +148,7 @@ class DemoClass(ABC, _PrivateClass):
  .. versionchanged:: 1.2
  Add `read_and_write_delete` property.
  """
+ #FIXME: For some reason, the alias Demo do ont appear in the class page :/
 
  def __init__(self, one: str, two: bytes) -> None:
  """
@@ -199,6 +203,12 @@ def read_and_write_delete(self) -> None:
  """
  This is a docstring for deleter.
  """
+ pass
+
+ ro = read_only
+ rw = read_and_write
+ rwd = read_and_write_delete
+
 
 class IContact(zope.interface.Interface):
  """
@@ -215,3 +225,6 @@ class IContact(zope.interface.Interface):
 
  def send_email(text: str) -> None:
  pass
+
+_Demo = _PrivateClass
+Demo = DemoClass

mypy.ini

@@ -14,6 +14,10 @@ warn_unused_ignores=True
 
 plugins=mypy_zope:plugin
 
+
+exclude = (?x)(
+ ^pydoctor\/test\/testpackages\/
+ )
 # The following modules are currently only partially annotated:
 
 [mypy-pydoctor.test.test_napoleon_docstring]