Skip to content

Improve and classify page content #593

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

Closed
wants to merge 4 commits into from
Closed

Improve and classify page content #593

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2ac9263
Regularize declaration markup.
dbuenzli Feb 15, 2021
acd184c
Classify the docstring div of declarations.
dbuenzli Feb 15, 2021
7e8e8ad
Except for headers and .mlds classify all children of .odoc-content.
dbuenzli Feb 15, 2021
1ca3e98
Promote expect tests to new markup structure.
dbuenzli Feb 18, 2021
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: 10 additions & 8 deletions src/html/generator.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,7 +278,9 @@ and items ~resolve l : item Html.elt list =
let content = flow_to_item @@ block ~resolve text in
let elts =
if only_text then content
else [ Html.aside (content :> any Html.elt list) ]
else
let a = [ Html.a_class [ "odoc-unattached" ] ] in
[ Html.aside ~a (content :> any Html.elt list) ]
in
elts |> (continue_with [@tailcall]) rest
| Heading h :: rest ->
Expand Down Expand Up @@ -308,7 +310,7 @@ and items ~resolve l : item Html.elt list =
let a = class_of_kind kind @ anchor_attrib in
(* TODO : Why double div ??? *)
[
Html.div
Html.div ~a:[ Html.a_class [ "odoc-include" ] ]
[
Html.div ~a
( anchor_link
Expand All @@ -321,13 +323,13 @@ and items ~resolve l : item Html.elt list =
let a = class_of_kind kind @ anchor_attrib in
let content = anchor_link @ documentedSrc ~resolve content in
let elts =
let content = div ~a content in
match doc with
| [] -> [ content ]
let doc = match doc with
| [] -> []
| docs ->
[
Html.div [ content; div (flow_to_item @@ block ~resolve docs) ];
]
let a = [ Html.a_class [ "spec-doc" ] ] in
[ div ~a (flow_to_item @@ block ~resolve docs) ]
in
[ div ~a: [ Html.a_class [ "odoc-spec" ]] (div ~a content :: doc) ]
in
(continue_with [@tailcall]) rest elts
and items l = walk_items ~only_text:(is_only_text l) [] l in
Expand Down
92 changes: 59 additions & 33 deletions test/html/expect/test_package+custom_theme,ml/Include/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,112 +23,138 @@ <h1>
</h1>
</header>
<div class="odoc-content">
<div class="spec module-type" id="module-type-Not_inlined">
<a href="#module-type-Not_inlined" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> </span><span><a href="module-type-Not_inlined/index.html">Not_inlined</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code>
<div class="odoc-spec">
<div class="spec module-type" id="module-type-Not_inlined">
<a href="#module-type-Not_inlined" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> </span><span><a href="module-type-Not_inlined/index.html">Not_inlined</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code>
</div>
</div>
<div>
<div class="odoc-include">
<div class="spec include">
<div class="doc">
<details open="open">
<summary>
<span class="def"><code><span><span class="keyword">include</span> <a href="module-type-Not_inlined/index.html">Not_inlined</a></span></code></span>
</summary>
<div class="spec type" id="type-t">
<a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span></code>
<div class="odoc-spec">
<div class="spec type" id="type-t">
<a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span></code>
</div>
</div>
</details>
</div>
</div>
</div>
<div class="spec module-type" id="module-type-Inlined">
<a href="#module-type-Inlined" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> </span><span><a href="module-type-Inlined/index.html">Inlined</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code>
<div class="odoc-spec">
<div class="spec module-type" id="module-type-Inlined">
<a href="#module-type-Inlined" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> </span><span><a href="module-type-Inlined/index.html">Inlined</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code>
</div>
</div>
<div>
<div class="odoc-include">
<div class="spec include">
<div class="doc">
<div class="spec type" id="type-u">
<a href="#type-u" class="anchor"></a><code><span><span class="keyword">type</span> u</span></code>
<div class="odoc-spec">
<div class="spec type" id="type-u">
<a href="#type-u" class="anchor"></a><code><span><span class="keyword">type</span> u</span></code>
</div>
</div>
</div>
</div>
</div>
<div class="spec module-type" id="module-type-Not_inlined_and_closed">
<a href="#module-type-Not_inlined_and_closed" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> </span><span><a href="module-type-Not_inlined_and_closed/index.html">Not_inlined_and_closed</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code>
<div class="odoc-spec">
<div class="spec module-type" id="module-type-Not_inlined_and_closed">
<a href="#module-type-Not_inlined_and_closed" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> </span><span><a href="module-type-Not_inlined_and_closed/index.html">Not_inlined_and_closed</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code>
</div>
</div>
<div>
<div class="odoc-include">
<div class="spec include">
<div class="doc">
<details>
<summary>
<span class="def"><code><span><span class="keyword">include</span> <a href="module-type-Not_inlined_and_closed/index.html">Not_inlined_and_closed</a></span></code></span>
</summary>
<div class="spec type" id="type-v">
<a href="#type-v" class="anchor"></a><code><span><span class="keyword">type</span> v</span></code>
<div class="odoc-spec">
<div class="spec type" id="type-v">
<a href="#type-v" class="anchor"></a><code><span><span class="keyword">type</span> v</span></code>
</div>
</div>
</details>
</div>
</div>
</div>
<div class="spec module-type" id="module-type-Not_inlined_and_opened">
<a href="#module-type-Not_inlined_and_opened" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> </span><span><a href="module-type-Not_inlined_and_opened/index.html">Not_inlined_and_opened</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code>
<div class="odoc-spec">
<div class="spec module-type" id="module-type-Not_inlined_and_opened">
<a href="#module-type-Not_inlined_and_opened" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> </span><span><a href="module-type-Not_inlined_and_opened/index.html">Not_inlined_and_opened</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code>
</div>
</div>
<div>
<div class="odoc-include">
<div class="spec include">
<div class="doc">
<details open="open">
<summary>
<span class="def"><code><span><span class="keyword">include</span> <a href="module-type-Not_inlined_and_opened/index.html">Not_inlined_and_opened</a></span></code></span>
</summary>
<div class="spec type" id="type-w">
<a href="#type-w" class="anchor"></a><code><span><span class="keyword">type</span> w</span></code>
<div class="odoc-spec">
<div class="spec type" id="type-w">
<a href="#type-w" class="anchor"></a><code><span><span class="keyword">type</span> w</span></code>
</div>
</div>
</details>
</div>
</div>
</div>
<div class="spec module-type" id="module-type-Inherent_Module">
<a href="#module-type-Inherent_Module" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> </span><span><a href="module-type-Inherent_Module/index.html">Inherent_Module</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code>
<div class="odoc-spec">
<div class="spec module-type" id="module-type-Inherent_Module">
<a href="#module-type-Inherent_Module" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> </span><span><a href="module-type-Inherent_Module/index.html">Inherent_Module</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code>
</div>
</div>
<div>
<div class="odoc-include">
<div class="spec include">
<div class="doc">
<details open="open">
<summary>
<span class="def"><code><span><span class="keyword">include</span> <a href="module-type-Inherent_Module/index.html">Inherent_Module</a></span></code></span>
</summary>
<div class="spec value" id="val-a">
<a href="#val-a" class="anchor"></a><code><span><span class="keyword">val</span> a : <a href="#type-t">t</a></span></code>
<div class="odoc-spec">
<div class="spec value" id="val-a">
<a href="#val-a" class="anchor"></a><code><span><span class="keyword">val</span> a : <a href="#type-t">t</a></span></code>
</div>
</div>
</details>
</div>
</div>
</div>
<div class="spec module-type" id="module-type-Dorminant_Module">
<a href="#module-type-Dorminant_Module" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> </span><span><a href="module-type-Dorminant_Module/index.html">Dorminant_Module</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code>
<div class="odoc-spec">
<div class="spec module-type" id="module-type-Dorminant_Module">
<a href="#module-type-Dorminant_Module" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> </span><span><a href="module-type-Dorminant_Module/index.html">Dorminant_Module</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code>
</div>
</div>
<div>
<div class="odoc-include">
<div class="spec include">
<div class="doc">
<details open="open">
<summary>
<span class="def"><code><span><span class="keyword">include</span> <a href="module-type-Dorminant_Module/index.html">Dorminant_Module</a></span></code></span>
</summary>
<div>
<div class="odoc-include">
<div class="spec include">
<div class="doc">
<details open="open">
<summary>
<span class="def"><code><span><span class="keyword">include</span> <a href="module-type-Inherent_Module/index.html">Inherent_Module</a></span></code></span>
</summary>
<div class="spec value" id="val-a">
<a href="#val-a" class="anchor"></a><code><span><span class="keyword">val</span> a : <a href="#type-t">t</a></span></code>
<div class="odoc-spec">
<div class="spec value" id="val-a">
<a href="#val-a" class="anchor"></a><code><span><span class="keyword">val</span> a : <a href="#type-t">t</a></span></code>
</div>
</div>
</details>
</div>
</div>
</div>
<div class="spec value" id="val-a">
<a href="#val-a" class="anchor"></a><code><span><span class="keyword">val</span> a : <a href="#type-u">u</a></span></code>
<div class="odoc-spec">
<div class="spec value" id="val-a">
<a href="#val-a" class="anchor"></a><code><span><span class="keyword">val</span> a : <a href="#type-u">u</a></span></code>
</div>
</div>
</details>
</div>
Expand Down
Loading