Skip to content
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

Jump to bottom

Fix gaps between preamble and content #1146

Closed
wants to merge 3 commits into from
Closed

Fix gaps between preamble and content #1146

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b2f45c4
Fix gaps (#1111)
panglesd Jun 10, 2024
04a5a28
Add changelof for #1146
panglesd Jun 10, 2024
f14a5a5
Fix gaps: Promote tests
panglesd Jun 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 2 additions & 0 deletions CHANGES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@
- Fixed title content not being picked up across pages when rendering references
(#1116, @panglesd)
- Fix wrong links to standalone comments in search results (#1118, @panglesd)
- Fix a big gap between the preamble and the content of a page (#1146,
@panglesd)


# 2.4.0
Expand Down
13 changes: 9 additions & 4 deletions src/html/html_page.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -210,10 +210,15 @@ let search_urls = %s;

let body =
html_of_breadcrumbs breadcrumbs
@ search_bar
@ [ Html.header ~a:[ Html.a_class [ "odoc-preamble" ] ] header ]
@ sidebar toc
@ [ Html.div ~a:[ Html.a_class [ "odoc-content" ] ] content ]
@ search_bar @ sidebar toc
@ [
Html.div
~a:[ Html.a_class [ "odoc-main" ] ]
[
Html.header ~a:[ Html.a_class [ "odoc-preamble" ] ] header;
Html.div ~a:[ Html.a_class [ "odoc-content" ] ] content;
];
]
in

let htmlpp = Html.pp ~indent:(Config.indent config) () in
Expand Down
9 changes: 2 additions & 7 deletions src/html_support_files/odoc.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -307,8 +307,8 @@ body.odoc-src {
margin-right: calc(10vw + 20ex);
}

.odoc-content {
grid-row: 4;
.odoc-main {
grid-row: 3;
grid-column: 2;
}

Expand All @@ -322,11 +322,6 @@ header {
margin-bottom: 30px;
}

header.odoc-preamble {
grid-column: 2;
grid-row: 3;
}

nav {
font-family: "Fira Sans", sans-serif;
}
Expand Down
14 changes: 8 additions & 6 deletions test/generators/html/Alerts-Top1.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,13 @@
<nav class="odoc-nav"><a href="Alerts.html">Up</a> –
<a href="Alerts.html">Alerts</a> &#x00BB; Top1
</nav>
<header class="odoc-preamble">
<h1>Module <code><span>Alerts.Top1</span></code></h1><p>Top-comment.</p>
<ul class="at-tags">
<li class="deprecated"><span class="at-tag">deprecated</span> A</li>
</ul>
</header><div class="odoc-content"></div>
<div class="odoc-main">
<header class="odoc-preamble">
<h1>Module <code><span>Alerts.Top1</span></code></h1><p>Top-comment.</p>
<ul class="at-tags">
<li class="deprecated"><span class="at-tag">deprecated</span> A</li>
</ul>
</header><div class="odoc-content"></div>
</div>
</body>
</html>
14 changes: 8 additions & 6 deletions test/generators/html/Alerts-Top2.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,13 @@
<nav class="odoc-nav"><a href="Alerts.html">Up</a> –
<a href="Alerts.html">Alerts</a> &#x00BB; Top2
</nav>
<header class="odoc-preamble">
<h1>Module <code><span>Alerts.Top2</span></code></h1><p>Top-comment.</p>
<ul class="at-tags">
<li class="deprecated"><span class="at-tag">deprecated</span> A</li>
</ul>
</header><div class="odoc-content"></div>
<div class="odoc-main">
<header class="odoc-preamble">
<h1>Module <code><span>Alerts.Top2</span></code></h1><p>Top-comment.</p>
<ul class="at-tags">
<li class="deprecated"><span class="at-tag">deprecated</span> A</li>
</ul>
</header><div class="odoc-content"></div>
</div>
</body>
</html>
203 changes: 103 additions & 100 deletions test/generators/html/Alerts.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,114 +8,117 @@
<script>hljs.initHighlightingOnLoad();</script>
</head>
<body class="odoc">
<header class="odoc-preamble">
<h1>Module <code><span>Alerts</span></code></h1>
</header>
<div class="odoc-content">
<div class="odoc-spec">
<div class="spec value anchored" id="val-a">
<a href="#val-a" class="anchor"></a>
<code><span><span class="keyword">val</span> a : int</span></code>
<div class="odoc-main">
<header class="odoc-preamble">
<h1>Module <code><span>Alerts</span></code></h1>
</header>
<div class="odoc-content">
<div class="odoc-spec">
<div class="spec value anchored" id="val-a">
<a href="#val-a" class="anchor"></a>
<code><span><span class="keyword">val</span> a : int</span></code>
</div>
<div class="spec-doc">
<ul class="at-tags">
<li class="deprecated"><span class="at-tag">deprecated</span> a</li>
</ul>
</div>
</div>
<div class="spec-doc">
<ul class="at-tags">
<li class="deprecated"><span class="at-tag">deprecated</span> a</li>
</ul>
<div class="odoc-spec">
<div class="spec value anchored" id="val-b">
<a href="#val-b" class="anchor"></a>
<code><span><span class="keyword">val</span> b : int</span></code>
</div>
<div class="spec-doc">
<ul class="at-tags">
<li class="deprecated"><span class="at-tag">deprecated</span>
<p>b.</p>
</li>
</ul>
</div>
</div>
</div>
<div class="odoc-spec">
<div class="spec value anchored" id="val-b">
<a href="#val-b" class="anchor"></a>
<code><span><span class="keyword">val</span> b : int</span></code>
<div class="odoc-spec">
<div class="spec value anchored" id="val-c">
<a href="#val-c" class="anchor"></a>
<code><span><span class="keyword">val</span> c : int</span></code>
</div>
<div class="spec-doc">
<ul class="at-tags">
<li class="deprecated"><span class="at-tag">deprecated</span> </li>
</ul>
</div>
</div>
<div class="spec-doc">
<ul class="at-tags">
<li class="deprecated"><span class="at-tag">deprecated</span> <p>b.</p>
</li>
</ul>
<div class="odoc-spec">
<div class="spec module anchored" id="module-Top1">
<a href="#module-Top1" class="anchor"></a>
<code>
<span><span class="keyword">module</span>
<a href="Alerts-Top1.html">Top1</a>
</span>
<span> : <span class="keyword">sig</span> ...
<span class="keyword">end</span>
</span>
</code>
</div><div class="spec-doc"><p>Top-comment.</p></div>
</div>
</div>
<div class="odoc-spec">
<div class="spec value anchored" id="val-c">
<a href="#val-c" class="anchor"></a>
<code><span><span class="keyword">val</span> c : int</span></code>
<div class="odoc-spec">
<div class="spec module anchored" id="module-Top2">
<a href="#module-Top2" class="anchor"></a>
<code>
<span><span class="keyword">module</span>
<a href="Alerts-Top2.html">Top2</a>
</span>
<span> : <span class="keyword">sig</span> ...
<span class="keyword">end</span>
</span>
</code>
</div><div class="spec-doc"><p>Top-comment.</p></div>
</div>
<div class="spec-doc">
<ul class="at-tags">
<li class="deprecated"><span class="at-tag">deprecated</span> </li>
</ul>
<div class="odoc-spec">
<div class="spec value anchored" id="val-d">
<a href="#val-d" class="anchor"></a>
<code><span><span class="keyword">val</span> d : int</span></code>
</div>
<div class="spec-doc">
<ul class="at-tags">
<li class="deprecated"><span class="at-tag">deprecated</span>
A deprecated alert d
</li>
</ul>
</div>
</div>
</div>
<div class="odoc-spec">
<div class="spec module anchored" id="module-Top1">
<a href="#module-Top1" class="anchor"></a>
<code>
<span><span class="keyword">module</span>
<a href="Alerts-Top1.html">Top1</a>
</span>
<span> : <span class="keyword">sig</span> ...
<span class="keyword">end</span>
</span>
</code>
</div><div class="spec-doc"><p>Top-comment.</p></div>
</div>
<div class="odoc-spec">
<div class="spec module anchored" id="module-Top2">
<a href="#module-Top2" class="anchor"></a>
<code>
<span><span class="keyword">module</span>
<a href="Alerts-Top2.html">Top2</a>
</span>
<span> : <span class="keyword">sig</span> ...
<span class="keyword">end</span>
</span>
</code>
</div><div class="spec-doc"><p>Top-comment.</p></div>
</div>
<div class="odoc-spec">
<div class="spec value anchored" id="val-d">
<a href="#val-d" class="anchor"></a>
<code><span><span class="keyword">val</span> d : int</span></code>
</div>
<div class="spec-doc">
<ul class="at-tags">
<li class="deprecated"><span class="at-tag">deprecated</span>
A deprecated alert d
</li>
</ul>
<div class="odoc-spec">
<div class="spec value anchored" id="val-d2">
<a href="#val-d2" class="anchor"></a>
<code><span><span class="keyword">val</span> d2 : int</span></code>
</div>
<div class="spec-doc">
<ul class="at-tags">
<li class="deprecated"><span class="at-tag">deprecated</span> </li>
</ul>
</div>
</div>
</div>
<div class="odoc-spec">
<div class="spec value anchored" id="val-d2">
<a href="#val-d2" class="anchor"></a>
<code><span><span class="keyword">val</span> d2 : int</span></code>
</div>
<div class="spec-doc">
<ul class="at-tags">
<li class="deprecated"><span class="at-tag">deprecated</span> </li>
</ul>
</div>
</div>
<div class="odoc-spec">
<div class="spec value anchored" id="val-e">
<a href="#val-e" class="anchor"></a>
<code><span><span class="keyword">val</span> e : int</span></code>
</div>
<div class="spec-doc">
<ul class="at-tags">
<li class="alert"><span class="at-tag">alert</span> e an alert</li>
</ul>
</div>
</div>
<div class="odoc-spec">
<div class="spec value anchored" id="val-f">
<a href="#val-f" class="anchor"></a>
<code><span><span class="keyword">val</span> f : int</span></code>
<div class="odoc-spec">
<div class="spec value anchored" id="val-e">
<a href="#val-e" class="anchor"></a>
<code><span><span class="keyword">val</span> e : int</span></code>
</div>
<div class="spec-doc">
<ul class="at-tags">
<li class="alert"><span class="at-tag">alert</span> e an alert</li>
</ul>
</div>
</div>
<div class="spec-doc">
<ul class="at-tags">
<li class="alert"><span class="at-tag">alert</span> f</li>
</ul>
<div class="odoc-spec">
<div class="spec value anchored" id="val-f">
<a href="#val-f" class="anchor"></a>
<code><span><span class="keyword">val</span> f : int</span></code>
</div>
<div class="spec-doc">
<ul class="at-tags">
<li class="alert"><span class="at-tag">alert</span> f</li>
</ul>
</div>
</div>
</div>
</div>
Expand Down
32 changes: 17 additions & 15 deletions test/generators/html/Alias-X.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,21 +11,23 @@
<nav class="odoc-nav"><a href="Alias.html">Up</a> –
<a href="Alias.html">Alias</a> &#x00BB; X
</nav>
<header class="odoc-preamble">
<h1>Module <code><span>Alias.X</span></code></h1>
</header>
<div class="odoc-content">
<div class="odoc-spec">
<div class="spec type anchored" id="type-t">
<a href="#type-t" class="anchor"></a>
<code><span><span class="keyword">type</span> t</span>
<span> = int</span>
</code>
</div>
<div class="spec-doc">
<p>Module Foo__X documentation. This should appear in the documentation
for the alias to this module 'X'
</p>
<div class="odoc-main">
<header class="odoc-preamble">
<h1>Module <code><span>Alias.X</span></code></h1>
</header>
<div class="odoc-content">
<div class="odoc-spec">
<div class="spec type anchored" id="type-t">
<a href="#type-t" class="anchor"></a>
<code><span><span class="keyword">type</span> t</span>
<span> = int</span>
</code>
</div>
<div class="spec-doc">
<p>Module Foo__X documentation. This should appear in the documentation
for the alias to this module 'X'
</p>
</div>
</div>
</div>
</div>
Expand Down
30 changes: 16 additions & 14 deletions test/generators/html/Alias.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,20 +8,22 @@
<script>hljs.initHighlightingOnLoad();</script>
</head>
<body class="odoc">
<header class="odoc-preamble">
<h1>Module <code><span>Alias</span></code></h1>
</header>
<div class="odoc-content">
<div class="odoc-spec">
<div class="spec module anchored" id="module-X">
<a href="#module-X" class="anchor"></a>
<code>
<span><span class="keyword">module</span> <a href="Alias-X.html">X</a>
</span>
<span> : <span class="keyword">sig</span> ...
<span class="keyword">end</span>
</span>
</code>
<div class="odoc-main">
<header class="odoc-preamble">
<h1>Module <code><span>Alias</span></code></h1>
</header>
<div class="odoc-content">
<div class="odoc-spec">
<div class="spec module anchored" id="module-X">
<a href="#module-X" class="anchor"></a>
<code>
<span><span class="keyword">module</span> <a href="Alias-X.html">X</a>
</span>
<span> : <span class="keyword">sig</span> ...
<span class="keyword">end</span>
</span>
</code>
</div>
</div>
</div>
</div>
Expand Down
Loading
Loading