Swap the ModulePageBuilder to use a template.

No output changes.

PiperOrigin-RevId: 421012042

Author: MarkDaoust

tools/tensorflow_docs/api_generator/pretty_docs/base_page.py

@@ -229,7 +229,7 @@ def build_other_members(other_members: List[MemberInfo], title: str):
             description='\n'.join(description),
         ))
   return '\n' + parser.TABLE_TEMPLATE.format(
-      title=title, text='', items=''.join(items)) + '\n'
+      title=title, text='', items=''.join(items))
 
 
 DECORATOR_ALLOWLIST = frozenset({

tools/tensorflow_docs/api_generator/pretty_docs/module_page.py

@@ -22,70 +22,21 @@
 from tensorflow_docs.api_generator.pretty_docs import base_page
 
 
-class ModulePageBuilder(base_page.PageBuilder):
+class ModulePageBuilder(base_page.TemplatePageBuilder):
   """Builds a markdown page from a `ModulePageInfo` instance."""
-
-  def build(self) -> str:
-    """Build the page."""
-    page_info = self.page_info
-    parts = [f'# Module: {page_info.full_name}\n\n']
-
-    parts.append('<!-- Insert buttons and diff -->\n')
-
-    parts.append(base_page.top_source_link(page_info.defined_in))
-    parts.append('\n\n')
-
-    # First line of the docstring i.e. a brief introduction about the symbol.
-    parts.append(page_info.doc.brief + '\n\n')
-
-    parts.append(base_page.build_collapsable_aliases(page_info.aliases))
-
-    parts.append(base_page.build_top_compat(page_info, h_level=2))
-
-    # All lines in the docstring, expect the brief introduction.
-    for item in page_info.doc.docstring_parts:
-      parts.append(base_page.format_docstring(item, table_title_template=None))
-
-    parts.append(base_page.build_bottom_compat(page_info, h_level=2))
-
-    parts.append('\n\n')
-
-    if page_info.modules:
-      parts.append('## Modules\n\n')
-      parts.extend(
-          _build_module_parts(
-              module_parts=page_info.modules,
-              template='[`{short_name}`]({url}) module'))
-
-    if page_info.classes:
-      parts.append('## Classes\n\n')
-      parts.extend(
-          _build_module_parts(
-              module_parts=page_info.classes,
-              template='[`class {short_name}`]({url})'))
-
-    if page_info.functions:
-      parts.append('## Functions\n\n')
-      parts.extend(
-          _build_module_parts(
-              module_parts=page_info.functions,
-              template='[`{short_name}(...)`]({url})'))
-
-    if page_info.type_alias:
-      parts.append('## Type Aliases\n\n')
-      parts.extend(
-          _build_module_parts(
-              module_parts=page_info.type_alias,
-              template='[`{short_name}`]({url})'))
-
-    if page_info.other_members:
-      parts.append(
-          base_page.build_other_members(
-              page_info.other_members,
-              title='<h2 class="add-link">Other Members</h2>',
-          ))
-
-    return ''.join(parts)
+  TEMPLATE = 'templates/module.jinja'
+
+  def __init__(self, page_info: 'ModulePageInfo'):
+    super().__init__(page_info)
+
+  def build_other_member_section(self):
+    if self.page_info.other_members:
+      return base_page.build_other_members(
+          self.page_info.other_members,
+          title='<h2 class="add-link">Other Members</h2>',
+      )
+    else:
+      return ''
 
 
 class ModulePageInfo(base_page.PageInfo):

tools/tensorflow_docs/api_generator/pretty_docs/templates/class.jinja

@@ -29,7 +29,7 @@
 {{- self.child_classes() -}}
 {{- self.methods() -}}
 
-{{- builder.build_other_member_section() -}}
+{{- self.other_members() -}}
 
 {{- builder.bottom_compat() -}}
 {% endblock body %}
@@ -63,5 +63,7 @@
 {#----------------------------------------------------------------------------#}
 
 {% block other_members %}
-{{ builder.build_other_member_section() -}}
+{%- if page_info.other_members -%}
+{{ builder.build_other_member_section() }}
+{% endif %}
 {% endblock other_members%}

tools/tensorflow_docs/api_generator/pretty_docs/templates/module.jinja

@@ -0,0 +1,99 @@
+{% extends "templates/page.jinja" %}
+
+{#----------------------------------------------------------------------------#}
+
+{% block header %}
+# Module: {{page_info.full_name}}
+
+<!-- Insert buttons and diff -->
+{% endblock header%}
+
+{#----------------------------------------------------------------------------#}
+
+{% block body %}
+{{ builder.top_compat() -}}
+
+  {% for part in page_info.doc.docstring_parts %}
+    {{- builder.format_docstring_part(part) -}}
+  {% endfor %}
+{{ builder.bottom_compat() }}
+
+{{ self.modules() }}
+{{- self.classes() }}
+{{- self.functions() }}
+{{- self.type_aliases() }}
+{{- self.other_members() -}}
+{% endblock body %}
+
+{#----------------------------------------------------------------------------#}
+
+{% block modules %}
+{%- if page_info.modules %}
+## Modules
+
+  {% for module in page_info.modules %}
+    {%if module.doc.brief%}
+[`{{module.short_name}}`]({{module.url}}) module: {{module.doc.brief}}
+    {%else%}
+[`{{module.short_name}}`]({{module.url}}) module
+    {%endif%}
+
+  {% endfor %}
+{% endif -%}
+{% endblock modules  %}
+
+{#----------------------------------------------------------------------------#}
+
+{% block classes %}
+{%- if page_info.classes %}
+## Classes
+
+  {% for cls in page_info.classes %}
+    {%if cls.doc.brief%}
+[`class {{cls.short_name}}`]({{cls.url}}): {{cls.doc.brief}}
+    {%else%}
+[`class {{cls.short_name}}`]({{cls.url}})
+    {%endif%}
+
+  {% endfor %}
+{% endif -%}
+{% endblock classes%}
+
+{#----------------------------------------------------------------------------#}
+
+{% block functions %}
+{%- if page_info.functions -%}
+## Functions
+
+  {% for fun in page_info.functions %}
+    {%if fun.doc.brief%}
+[`{{fun.short_name}}(...)`]({{fun.url}}): {{fun.doc.brief}}
+    {%else%}
+[`{{fun.short_name}}(...)`]({{fun.url}})
+    {%endif%}
+
+  {% endfor %}
+{% endif -%}
+{% endblock functions%}
+
+{#----------------------------------------------------------------------------#}
+
+{% block type_aliases %}
+{%- if page_info.type_alias -%}
+## Type Aliases
+
+  {% for alias in page_info.type_alias %}
+[`{{alias.short_name}}`]({{alias.url}})
+
+  {% endfor %}
+{% endif -%}
+{% endblock type_aliases%}
+
+{#----------------------------------------------------------------------------#}
+
+{% block other_members %}
+{%- if page_info.other_members -%}
+{{ builder.build_other_member_section() }}
+{% endif %}
+{% endblock other_members%}
+