Swap the TypeAliasPageBuilder to use a template.

No output changes.

PiperOrigin-RevId: 416268003

Author: MarkDaoust

tools/tensorflow_docs/api_generator/parser.py

@@ -1908,6 +1908,7 @@ class ClassPageInfo(PageInfo):
       defined inside the class object (mostly enum style fields).
     attr_block: A `TitleBlock` containing information about the Attributes of
       the class.
+    inheritable_header: A header that may be placed on a base-class.
   """
 
   def __init__(self, *, full_name, py_object, **kwargs):
@@ -1939,6 +1940,13 @@ def bases(self):
     """Returns a list of `MemberInfo` objects pointing to the class' parents."""
     return self._bases
 
+  @property
+  def inheritable_header(self) -> Optional[str]:
+    header = doc_controls.get_inheritable_header(self.py_object)
+    if header is not None:
+      header = textwrap.dedent(header)
+    return header
+
   def set_attr_block(self, attr_block):
     assert self.attr_block is None
     self.attr_block = attr_block

tools/tensorflow_docs/api_generator/pretty_docs.py

@@ -142,43 +142,19 @@ def format_docstring_part(self, part):
     return _format_docstring(part, table_title_template=ttt)
 
   def build_signature(self):
-    if self.page_info.signature:
-      return _build_signature(self.page_info)
+    return _build_signature(self.page_info)
 
 
-class TypeAliasPageBuilder(PageBuilder):
+class TypeAliasPageBuilder(TemplatePageBuilder):
   """Builds a markdown page from a `TypeAliasPageBuilder` object."""
+  TEMPLATE = 'templates/type_alias.jinja'
 
   def __init__(self, page_info: parser.TypeAliasPageInfo):
     super().__init__(page_info)
 
-  def build(self) -> str:
-    """Builds and returns a markdown page."""
-    page_info = self.page_info
-
-    parts = [f'# {page_info.full_name}\n\n']
-
-    parts.append('<!-- Insert buttons and diff -->\n')
-
-    parts.append('This symbol is a **type alias**.\n\n')
-    parts.append(page_info.doc.brief)
-    parts.append('\n\n')
-
-    if page_info.signature is not None:
-      parts.append('#### Source:\n\n')
-      parts.append(
-          _build_signature(
-              page_info, obj_name=page_info.short_name, type_alias=True))
-      parts.append('\n\n')
-
-    parts.append('<!-- Placeholder for "Used in" -->\n')
-
-    for item in page_info.doc.docstring_parts:
-      parts.append(
-          _format_docstring(
-              item, table_title_template='<h2 class="add-link">{title}</h2>'))
-
-    return ''.join(parts)
+  def build_signature(self):
+    return _build_signature(
+        self.page_info, obj_name=self.page_info.short_name, type_alias=True)
 
 
 class Methods(NamedTuple):
@@ -307,13 +283,6 @@ def __init__(self, page_info: parser.ClassPageInfo):
     # Split the methods into constructor and other methods.
     self.methods = split_methods(page_info.methods)
 
-  def build_inheritable_header(self):
-    header = doc_controls.get_inheritable_header(self.page_info.py_object)
-    if header is None:
-      return ''
-    else:
-      return '\n\n' + textwrap.dedent(header)
-
   def build_bases(self):
     page_info = self.page_info
     # If a class is a child class, add which classes it inherits from.

tools/tensorflow_docs/api_generator/templates/class.jinja

@@ -6,7 +6,13 @@
 {{ builder.top_source_link() }}
 
 {{ page_info.doc.brief -}}
-{{ builder.build_inheritable_header() }}
+
+{% if page_info.inheritable_header %}
+
+
+{{ page_info.inheritable_header -}}
+{% endif %}
+
 {{ builder.build_bases() }}
 {{ builder.build_collapsable_aliases() -}}
 {{ builder.build_constructor() -}}

tools/tensorflow_docs/api_generator/templates/function.jinja

@@ -1,6 +1,8 @@
 {% extends "templates/page.jinja" %}
 
 {% block body %}
+{% if page_info.signature %}
 {{ builder.build_signature() }}
+{% endif %}
 {{ super() -}}
 {% endblock %}

tools/tensorflow_docs/api_generator/templates/type_alias.jinja

@@ -0,0 +1,20 @@
+{% extends "templates/page.jinja" %}
+
+
+{% block metadata %}
+This symbol is a **type alias**.
+
+{{ page_info.doc.brief }}
+
+{% endblock metadata %}
+
+{#----------------------------------------------------------------------------#}
+
+{% block body %}
+{% if page_info.signature %}
+#### Source:
+
+{{ builder.build_signature() }}
+{% endif %}
+{{ super() -}}
+{% endblock %}