Render type aliases properly rather than as an assignment

Closes #414

Author: AWhetter

autoapi/_objects.py

@@ -351,6 +351,9 @@ def __init__(self, *args, **kwargs):
         or annotation comment was not given.
         """
 
+    def is_type_alias(self):
+        return self.annotation in ("TypeAlias", "typing.TypeAlias")
+
 
 class PythonAttribute(PythonData):
     """An object/class level attribute."""

autoapi/_parser.py

@@ -405,6 +405,12 @@ def parse_typealias(self, node):
         ):
             doc = doc_node.value.value
 
+        type_ = "data"
+        if isinstance(
+            node.scope(), astroid.nodes.ClassDef
+        ) or _astroid_utils.is_constructor(node.scope()):
+            type_ = "attribute"
+
         if isinstance(node.name, astroid.nodes.AssignName):
             name = node.name.name
         elif isinstance(node.name, astroid.nodes.AssignAttr):
@@ -413,7 +419,7 @@ def parse_typealias(self, node):
             return []
 
         data = {
-            "type": "data",
+            "type": type_,
             "name": name,
             "qual_name": self._get_qual_name(name),
             "full_name": self._get_full_name(name),

autoapi/templates/python/data.rst

@@ -4,14 +4,20 @@
 {{ "=" * obj.id | length }}
 
    {% endif %}
-.. py:{{ obj.type }}:: {% if is_own_page %}{{ obj.id }}{% else %}{{ obj.name }}{% endif %}
-   {% if obj.annotation is not none %}
+.. py:{% if obj.is_type_alias() %}type{% else %}{{ obj.type }}{% endif %}:: {% if is_own_page %}{{ obj.id }}{% else %}{{ obj.name }}{% endif %}
+   {% if obj.is_type_alias() %}
+      {% if obj.value %}
+
+   :canonical: {{ obj.value }}
+      {% endif %}
+   {% else %}
+      {% if obj.annotation is not none %}
 
    :type: {% if obj.annotation %} {{ obj.annotation }}{% endif %}
-   {% endif %}
-   {% if obj.value is not none %}
+      {% endif %}
+      {% if obj.value is not none %}
 
-      {% if obj.value.splitlines()|count > 1 %}
+         {% if obj.value.splitlines()|count > 1 %}
    :value: Multiline-String
 
    .. raw:: html
@@ -26,8 +32,9 @@
 
       </details>
 
-      {% else %}
+         {% else %}
    :value: {{ obj.value|truncate(100) }}
+         {% endif %}
       {% endif %}
    {% endif %}
 

docs/changes/414.feature.rst

@@ -0,0 +1 @@
+Render type aliases properly rather than as an assignment

pyproject.toml

@@ -29,7 +29,7 @@ dependencies = [
     'astroid>=3;python_version>="3.12"',
     "Jinja2",
     "PyYAML",
-    "sphinx>=6.1.0",
+    "sphinx>=7.4.0",
     'stdlib_list;python_version<"3.10"',
 ]
 dynamic = ["version"]

tests/python/test_pyintegration.py

@@ -747,16 +747,12 @@ def test_integration(self, parse):
         alias = example_file.find(id="example.MyTypeAliasA")
         properties = alias.find_all(class_="property")
         assert len(properties) == 2
-        annotation = properties[0].text
-        assert annotation == ": TypeAlias"
         value = properties[1].text
         assert value == " = tuple[str, int]"
 
         alias = example_file.find(id="example.MyTypeAliasB")
         properties = alias.find_all(class_="property")
         assert len(properties) == 2
-        annotation = properties[0].text
-        assert annotation == ": TypeAlias"
         value = properties[1].text
         assert value == " = tuple[str, int]"