Skip to content

epub: fix links to extra documents #2199

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
milmazz merged 1 commit into from
Feb 9, 2026
Merged

epub: fix links to extra documents #2199

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions lib/ex_doc/formatter/epub/templates/content_template.eex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<manifest>
<item id="nav" href="nav.xhtml" media-type="application/xhtml+xml" properties="nav scripted"/>
<item id="cover" href="title.xhtml" media-type="application/xhtml+xml" properties="scripted"/>
<%= for {_title, extras} <- extras, extra <- extras do %>
<%= for extra <- extras do %>
<item id="<%= URI.encode extra.id %>" href="<%= URI.encode extra.id %>.xhtml" media-type="application/xhtml+xml" properties="scripted"/>
<% end %>
<%= for node <- modules ++ tasks do %>
Expand All @@ -36,7 +36,7 @@
<spine>
<itemref idref="cover"/>
<itemref idref="nav"/>
<%= for {_title, extras} <- extras, extra <- extras do %>
<%= for extra <- extras do %>
<itemref idref="<%= URI.encode extra.id %>"/>
<% end %>
<%= for node <- modules ++ tasks do %>
Expand Down
18 changes: 18 additions & 0 deletions test/ex_doc/formatter/epub/templates_test.exs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,24 @@ defmodule ExDoc.Formatter.EPUB.TemplatesTest do

assert content =~ ~S|<itemref idref="XPTOModule"/>|
end

test "includes extras as resource" do
node =
%ExDoc.ExtraNode{
id: "changelog",
title: "Changelog",
doc: nil,
type: :extra
}

content =
Templates.content_template(formatter_config(), [], [], [node], "uuid", "datetime", [])

assert content =~
~S|<item id="changelog" href="changelog.xhtml" media-type="application/xhtml+xml" properties="scripted"/>|

assert content =~ ~S|<itemref idref="changelog"/>|
end
end

describe "module_template/2" do
Expand Down
Loading