Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
18 changes: 13 additions & 5 deletions pages/reference/show.xnode
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,21 @@
if nested.any?
?>
<section>
<h2>Nested</h2>
<h2>Classes and Modules</h2>

<ul>
<?r nested.each do |symbol| ?>
<li><a href="#{base.link_for(symbol)}"><code class="language-#{symbol.language.name}">#{symbol.nested_name}</code></a></li>
<dl class="nested-definitions">
<?r nested.each do |symbol|
documentation = symbol.documentation
if text = documentation&.text
description = text.take_while{|line| !line.empty?}.join("\n")
end
?>
<div>
<dt>#{partial 'content:declaration', symbol: symbol, link: true}</dt>
<dd><?r unless description&.empty? ?>#{base.format(description, symbol)}<?r end ?></dd>
</div>
<?r end ?>
</ul>
</dl>
</section>
<?r
end
Expand Down
31 changes: 31 additions & 0 deletions public/_static/site.css
Original file line number Diff line number Diff line change
Expand Up @@ -437,6 +437,37 @@ dl.relationships dt, dl.relationships dd {
margin: 0;
}

dl.nested-definitions {
display: grid;
grid-template-columns: repeat(auto-fit, minmax(18rem, 1fr));
gap: 1.5rem 2rem;
}

dl.nested-definitions > div {
min-width: 0;
}

dl.nested-definitions dt, dl.nested-definitions dd,
dl.nested-definitions dd p {
margin: 0;
}

dl.nested-definitions dt {
font-size: 1.05em;
}

dl.nested-definitions dt code,
dl.nested-definitions dt syntax-code {
display: block;
max-width: 100%;
white-space: pre-wrap;
overflow-wrap: anywhere;
}

dl.nested-definitions dd {
margin-top: 0.25rem;
}

ul.index {
padding: 0;
list-style: none;
Expand Down
9 changes: 9 additions & 0 deletions test/utopia/project/serve.rb
Original file line number Diff line number Diff line change
Expand Up @@ -84,4 +84,13 @@
expect(body).to be(:include?, "<dt>Inherits from</dt>")
expect(body).to be(:include?, "/reference/Utopia/Project/Document/index#Utopia%3A%3AProject%3A%3ADocument%23root")
end

it "summarizes nested definitions" do
body = client.get("/reference/Utopia/Project/index").read

expect(body).to be(:include?, "Classes and Modules")
expect(body).to be(:include?, '<dl class="nested-definitions">')
expect(body).to be(:include?, '<a href="/reference/Utopia/Project/Document/index">class Document</a>')
expect(body).to be(:include?, "Represents a Markdown document with optional source code cross-references.")
end
end
Loading