Add link headings to epub

Author: josevalim

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

@@ -2,7 +2,7 @@
     <h1 id="content">
       <%= title_content %>
     </h1>
-    <%= content %>
+    <%= H.link_headings(content) %>
     <%# Extra content specified by the user (e.g. custom Javascript) %>
     <%= before_closing_body_tag(config, :epub) %>
   </body>

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

@@ -11,7 +11,7 @@
 
     <%= if doc = module.rendered_doc do %>
       <section id="moduledoc" class="docstring">
-        <%= doc %>
+        <%= H.link_moduledoc_headings(doc) %>
       </section>
     <% end %>
 

lib/ex_doc/formatter/html/templates.ex

@@ -228,6 +228,9 @@ defmodule ExDoc.Formatter.HTML.Templates do
 
   defp relative_asset([h | _], output, _pattern), do: Path.relative_to(h, output)
 
+  # TODO: Move link_headings and friends to html.ex or even to autolinking code,
+  # so content is built with it upfront instead of added at the template level.
+
   @doc """
   Link headings found with `regex` with in the given `content`. IDs are
   prefixed with `prefix`.
@@ -307,11 +310,11 @@ defmodule ExDoc.Formatter.HTML.Templates do
     """
   end
 
-  defp link_moduledoc_headings(content) do
+  def link_moduledoc_headings(content) do
     link_headings(content, @heading_regex, "module-")
   end
 
-  defp link_detail_headings(content, prefix) do
+  def link_detail_headings(content, prefix) do
     link_headings(content, @heading_regex, prefix <> "-")
   end
 

test/ex_doc/formatter/epub/templates_test.exs

@@ -59,6 +59,12 @@ defmodule ExDoc.Formatter.EPUB.TemplatesTest do
       assert content =~ ~r{<title>CompiledWithDocs [^<]*</title>}
       assert content =~ ~r{<h1 id="content">\s*CompiledWithDocs\s*}
 
+      assert content =~
+               ~r{<h2 id="module-example-unicode-escaping" class="section-heading">.*<a href="#module-example-unicode-escaping">.*<i class="ri-link-m" aria-hidden="true"></i>.*Example.*</a>.*</h2>}ms
+
+      assert content =~
+               ~r{<h3 id="module-example-h3-heading" class="section-heading">.*<a href="#module-example-h3-heading">.*<i class="ri-link-m" aria-hidden="true"></i>.*Example H3 heading.*</a>.*</h3>}ms
+
       assert content =~
                ~r{moduledoc.*Example.*<samp class="nc">CompiledWithDocs</samp><samp class="o">\.</samp><samp class="n">example</samp>.*}ms