Change headings' levels to match their context

Author: DavidOliver

assets/css/content/general.css

@@ -86,16 +86,13 @@ which we style as h2 and h3. */
     margin-top: 1.75em;
   }
 
-  & h2,
-  & :is(#summary, #types, #callbacks, #functions) > h1.section-heading {
+  & h2 {
     font-size: var(--h2-size);
     margin-top: 1.5em;
     margin-bottom: 0.5em;
   }
 
-  & h3,
-  & :is(#summary, #types, #callbacks, #functions) > h2.section-heading,
-  & #summary :is(.summary-types, .summary-callbacks, .summary-functions) h2 {
+  & h3 {
     font-size: var(--h3-size);
     margin-top: 1.5em;
     margin-bottom: 0.5em;

assets/css/content/summary.css

@@ -1,4 +1,5 @@
-.content-inner .summary h2 a {
+/* Summary section subheading (e.g., Types) */
+.content-inner .summary h3 a {
   text-decoration: none;
   border: none;
   color: var(--textHeaders) !important;

lib/ex_doc/formatter/epub/templates/module_template.eex

@@ -17,14 +17,14 @@
 
     <%= if module.docs_groups != [] do %>
       <section id="summary" class="details-list">
-        <h1 class="section-heading">Summary</h1>
+        <h2 class="section-heading">Summary</h2>
         <%= for group <- module.docs_groups, do: H.summary_template(group.title, group.docs) %>
       </section>
     <% end %>
 
     <%= for group <- module.docs_groups, key = text_to_id(group.title) do %>
       <section id="<%= key %>" class="details-list">
-        <h1 class="section-heading"><%=h to_string(group.title) %></h1>
+        <h2 class="section-heading"><%=h to_string(group.title) %></h2>
         <%= if doc = group.doc do %>
           <div class="group-description" id="group-description-<%= key %>">
             <%= render_doc(doc) %>

lib/ex_doc/formatter/html/templates/module_template.eex

@@ -36,24 +36,24 @@
 
 <%= if module.docs_groups != [] do %>
   <section id="summary" class="details-list">
-    <h1 class="section-heading">
+    <h2 class="section-heading">
       <a class="hover-link" href="#summary">
         <i class="ri-link-m" aria-hidden="true"></i>
       </a>
       <span class="text">Summary</span>
-    </h1>
+    </h2>
     <%= for group <- module.docs_groups, do: summary_template(group.title, group.docs) %>
   </section>
 <% end %>
 
 <%= for group <- module.docs_groups, key = text_to_id(group.title) do %>
   <section id="<%= key %>" class="details-list">
-    <h1 class="section-heading">
+    <h2 class="section-heading">
       <a class="hover-link" href="#<%= key %>">
         <i class="ri-link-m" aria-hidden="true"></i>
       </a>
       <span class="text"><%= group.title %></span>
-    </h1>
+    </h2>
     <%= if doc = group.doc do %>
       <div class="group-description" id="group-description-<%= key %>">
        <%= render_doc(doc) %>

lib/ex_doc/formatter/html/templates/summary_template.eex

@@ -1,7 +1,7 @@
 <div class="summary-<%= text_to_id(name) %> summary">
-  <h2>
+  <h3>
     <a href="#<%=h text_to_id(name) %>"><%= name %></a>
-  </h2>
+  </h3>
   <%= for node <- nodes do %>
     <div class="summary-row">
       <div class="summary-signature">

test/ex_doc/formatter/epub/templates_test.exs

@@ -125,7 +125,7 @@ defmodule ExDoc.Formatter.EPUB.TemplatesTest do
       assert content =~ ~r{<title>CompiledWithDocs [^<]*</title>}
       assert content =~ ~r{<h1 id="content">\s*CompiledWithDocs\s*}
 
-      assert content =~ ~s{<h1 class="section-heading">Summary</h1>}
+      assert content =~ ~s{<h2 class="section-heading">Summary</h2>}
 
       assert content =~
                ~r{<h2 id="module-example-unicode-escaping">.*Example.*</h2>}ms