Current section

Files

Jump to
remedy_exdoc lib ex_doc formatter html templates module_template.eex
Raw

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

<%= head_template(config, %{title: module.title, type: module.type}) %>
<%= sidebar_template(config, nodes_map) %>
<h1>
<%= settings_button_template() %>
<%= if module.source_url do %>
<a href="<%= module.source_url %>" title="View Source" class="view-source" rel="help">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
<% end %>
<span translate="no"><%= module.title %></span> <%= module_type(module) %>
<small class="app-vsn" translate="no">(<%= config.project %> v<%= config.version %>)</small>
<%= for annotation <- module.annotations do %>
<span class="note">(<%= annotation %>)</span>
<% end %>
</h1>
<%= if deprecated = module.deprecated do %>
<div class="deprecated">
This <%= module.type %> is deprecated. <%= h(deprecated) %>.
</div>
<% end %>
<%= if doc = module.rendered_doc do %>
<section id="moduledoc">
<%= link_moduledoc_headings(doc) %>
</section>
<% end %>
<%= if Enum.any?(summary, fn {_, v} -> v != [] end) do %>
<section id="summary" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#summary">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this section</span>
</a>
Summary
</h1>
<%= for {name, nodes} <- summary, do: summary_template(name, nodes) %>
</section>
<% end %>
<%= for {name, nodes} <- summary, nodes != [], key = HTML.text_to_id(name) do %>
<section id="<%= key %>" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#<%= key %>">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this section</span>
</a>
<%= name %>
</h1>
<div class="<%= key %>-list">
<%= for node <- nodes, do: detail_template(node, module) %>
</div>
</section>
<% end %>
<%= footer_template(config, module) %>