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

Add anchors to type extensions #684

Merged
merged 1 commit into from
Jun 9, 2021
Merged

Add anchors to type extensions #684

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
2 changes: 1 addition & 1 deletion src/document/generator.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -559,7 +559,7 @@ module Make (Syntax : SYNTAX) = struct
(if Syntax.Type.type_def_semicolon then O.txt ";" else O.noop)
in
let attr = [ "type"; "extension" ] in
let anchor = None in
let anchor = Some (Url.Anchor.extension_decl t) in
let doc = Comment.to_ir t.doc in
Item.Declaration { attr; anchor; doc; content }

Expand Down
9 changes: 9 additions & 0 deletions src/document/url.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -265,6 +265,15 @@ module Anchor = struct
let kind = "constructor" in
let suffix = name in
add_suffix ~kind url suffix)

(** The anchor looks like
[extension-decl-"Path.target_type"-FirstConstructor]. *)
let extension_decl (decl : Odoc_model.Lang.Extension.t) =
let page = Path.from_identifier (decl.parent :> Path.source) in
let kind = "extension-decl" in
let first_cons = Identifier.name (List.hd decl.constructors).id in
let anchor = Printf.sprintf "%s-%s" kind first_cons in
{ page; kind; anchor }
end

type t = Anchor.t
Expand Down
4 changes: 4 additions & 0 deletions src/document/url.mli
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,10 @@ module Anchor : sig
type_ident:Identifier.t ->
Odoc_model.Lang.TypeExpr.Polymorphic_variant.element ->
t

val extension_decl : Odoc_model.Lang.Extension.t -> t
(** Anchor for the extension declaration item itself, which doesn't have an
identifier in the model. *)
end

type t = Anchor.t
Expand Down
4 changes: 2 additions & 2 deletions test/html/expect/test_package+ml/Labels/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,8 +105,8 @@ <h2 id="L2">
</div>
</div>
<div class="odoc-spec">
<div class="spec type extension">
<code><span><span class="keyword">type</span> <a href="#type-x">x</a> += </span></code>
<div class="spec type extension" id="extension-decl-X">
<a href="#extension-decl-X" class="anchor"></a><code><span><span class="keyword">type</span> <a href="#type-x">x</a> += </span></code>
<table>
<tbody>
<tr id="extension-X" class="anchored">
Expand Down
40 changes: 20 additions & 20 deletions test/html/expect/test_package+ml/Ocamlary/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1369,8 +1369,8 @@ <h4 id="advanced-type-stuff">
</div>
</div>
<div class="odoc-spec">
<div class="spec type extension">
<code><span><span class="keyword">type</span> <a href="#type-ext">ext</a> += </span></code>
<div class="spec type extension" id="extension-decl-ExtA">
<a href="#extension-decl-ExtA" class="anchor"></a><code><span><span class="keyword">type</span> <a href="#type-ext">ext</a> += </span></code>
<table>
<tbody>
<tr id="extension-ExtA" class="anchored">
Expand All @@ -1383,8 +1383,8 @@ <h4 id="advanced-type-stuff">
</div>
</div>
<div class="odoc-spec">
<div class="spec type extension">
<code><span><span class="keyword">type</span> <a href="#type-ext">ext</a> += </span></code>
<div class="spec type extension" id="extension-decl-ExtB">
<a href="#extension-decl-ExtB" class="anchor"></a><code><span><span class="keyword">type</span> <a href="#type-ext">ext</a> += </span></code>
<table>
<tbody>
<tr id="extension-ExtB" class="anchored">
Expand All @@ -1397,8 +1397,8 @@ <h4 id="advanced-type-stuff">
</div>
</div>
<div class="odoc-spec">
<div class="spec type extension">
<code><span><span class="keyword">type</span> <a href="#type-ext">ext</a> += </span></code>
<div class="spec type extension" id="extension-decl-ExtC">
<a href="#extension-decl-ExtC" class="anchor"></a><code><span><span class="keyword">type</span> <a href="#type-ext">ext</a> += </span></code>
<table>
<tbody>
<tr id="extension-ExtC" class="anchored">
Expand All @@ -1416,8 +1416,8 @@ <h4 id="advanced-type-stuff">
</div>
</div>
<div class="odoc-spec">
<div class="spec type extension">
<code><span><span class="keyword">type</span> <a href="#type-ext">ext</a> += </span></code>
<div class="spec type extension" id="extension-decl-ExtE">
<a href="#extension-decl-ExtE" class="anchor"></a><code><span><span class="keyword">type</span> <a href="#type-ext">ext</a> += </span></code>
<table>
<tbody>
<tr id="extension-ExtE" class="anchored">
Expand All @@ -1430,8 +1430,8 @@ <h4 id="advanced-type-stuff">
</div>
</div>
<div class="odoc-spec">
<div class="spec type extension">
<code><span><span class="keyword">type</span> <a href="#type-ext">ext</a> += </span></code>
<div class="spec type extension" id="extension-decl-ExtF">
<a href="#extension-decl-ExtF" class="anchor"></a><code><span><span class="keyword">type</span> <a href="#type-ext">ext</a> += </span></code>
<table>
<tbody>
<tr id="extension-ExtF" class="anchored">
Expand All @@ -1454,8 +1454,8 @@ <h4 id="advanced-type-stuff">
</div>
</div>
<div class="odoc-spec">
<div class="spec type extension">
<code><span><span class="keyword">type</span> <a href="#type-poly_ext">poly_ext</a> += </span></code>
<div class="spec type extension" id="extension-decl-Foo">
<a href="#extension-decl-Foo" class="anchor"></a><code><span><span class="keyword">type</span> <a href="#type-poly_ext">poly_ext</a> += </span></code>
<table>
<tbody>
<tr id="extension-Foo" class="anchored">
Expand All @@ -1480,8 +1480,8 @@ <h4 id="advanced-type-stuff">
</div>
</div>
<div class="odoc-spec">
<div class="spec type extension">
<code><span><span class="keyword">type</span> <a href="#type-poly_ext">poly_ext</a> += </span></code>
<div class="spec type extension" id="extension-decl-Quux">
<a href="#extension-decl-Quux" class="anchor"></a><code><span><span class="keyword">type</span> <a href="#type-poly_ext">poly_ext</a> += </span></code>
<table>
<tbody>
<tr id="extension-Quux" class="anchored">
Expand All @@ -1506,8 +1506,8 @@ <h4 id="advanced-type-stuff">
</div>
</div>
<div class="odoc-spec">
<div class="spec type extension">
<code><span><span class="keyword">type</span> <a href="ExtMod/index.html#type-t">ExtMod.t</a> += </span></code>
<div class="spec type extension" id="extension-decl-ZzzTop0">
<a href="#extension-decl-ZzzTop0" class="anchor"></a><code><span><span class="keyword">type</span> <a href="ExtMod/index.html#type-t">ExtMod.t</a> += </span></code>
<table>
<tbody>
<tr id="extension-ZzzTop0" class="anchored">
Expand All @@ -1527,8 +1527,8 @@ <h4 id="advanced-type-stuff">
</div>
</div>
<div class="odoc-spec">
<div class="spec type extension">
<code><span><span class="keyword">type</span> <a href="ExtMod/index.html#type-t">ExtMod.t</a> += </span></code>
<div class="spec type extension" id="extension-decl-ZzzTop">
<a href="#extension-decl-ZzzTop" class="anchor"></a><code><span><span class="keyword">type</span> <a href="ExtMod/index.html#type-t">ExtMod.t</a> += </span></code>
<table>
<tbody>
<tr id="extension-ZzzTop" class="anchored">
Expand Down Expand Up @@ -1996,8 +1996,8 @@ <h2 id="new-reference-syntax">
</div>
</div>
<div class="odoc-spec">
<div class="spec type extension">
<code><span><span class="keyword">type</span> <a href="#type-new_t">new_t</a> += </span></code>
<div class="spec type extension" id="extension-decl-C">
<a href="#extension-decl-C" class="anchor"></a><code><span><span class="keyword">type</span> <a href="#type-new_t">new_t</a> += </span></code>
<table>
<tbody>
<tr id="extension-C" class="anchored">
Expand Down
4 changes: 2 additions & 2 deletions test/html/expect/test_package+ml/Type/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -478,8 +478,8 @@ <h1>
</div>
</div>
<div class="odoc-spec">
<div class="spec type extension">
<code><span><span class="keyword">type</span> <a href="#type-extensible">extensible</a> += </span></code>
<div class="spec type extension" id="extension-decl-Extension">
<a href="#extension-decl-Extension" class="anchor"></a><code><span><span class="keyword">type</span> <a href="#type-extensible">extensible</a> += </span></code>
<table>
<tbody>
<tr id="extension-Extension" class="anchored">
Expand Down
4 changes: 2 additions & 2 deletions test/html/expect/test_package+re/Labels/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,8 +105,8 @@ <h2 id="L2">
</div>
</div>
<div class="odoc-spec">
<div class="spec type extension">
<code><span><span class="keyword">type</span> <a href="#type-x">x</a> += </span></code>
<div class="spec type extension" id="extension-decl-X">
<a href="#extension-decl-X" class="anchor"></a><code><span><span class="keyword">type</span> <a href="#type-x">x</a> += </span></code>
<table>
<tbody>
<tr id="extension-X" class="anchored">
Expand Down
40 changes: 20 additions & 20 deletions test/html/expect/test_package+re/Ocamlary/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1377,8 +1377,8 @@ <h4 id="advanced-type-stuff">
</div>
</div>
<div class="odoc-spec">
<div class="spec type extension">
<code><span><span class="keyword">type</span> <a href="#type-ext">ext</a> += </span></code>
<div class="spec type extension" id="extension-decl-ExtA">
<a href="#extension-decl-ExtA" class="anchor"></a><code><span><span class="keyword">type</span> <a href="#type-ext">ext</a> += </span></code>
<table>
<tbody>
<tr id="extension-ExtA" class="anchored">
Expand All @@ -1392,8 +1392,8 @@ <h4 id="advanced-type-stuff">
</div>
</div>
<div class="odoc-spec">
<div class="spec type extension">
<code><span><span class="keyword">type</span> <a href="#type-ext">ext</a> += </span></code>
<div class="spec type extension" id="extension-decl-ExtB">
<a href="#extension-decl-ExtB" class="anchor"></a><code><span><span class="keyword">type</span> <a href="#type-ext">ext</a> += </span></code>
<table>
<tbody>
<tr id="extension-ExtB" class="anchored">
Expand All @@ -1407,8 +1407,8 @@ <h4 id="advanced-type-stuff">
</div>
</div>
<div class="odoc-spec">
<div class="spec type extension">
<code><span><span class="keyword">type</span> <a href="#type-ext">ext</a> += </span></code>
<div class="spec type extension" id="extension-decl-ExtC">
<a href="#extension-decl-ExtC" class="anchor"></a><code><span><span class="keyword">type</span> <a href="#type-ext">ext</a> += </span></code>
<table>
<tbody>
<tr id="extension-ExtC" class="anchored">
Expand All @@ -1427,8 +1427,8 @@ <h4 id="advanced-type-stuff">
</div>
</div>
<div class="odoc-spec">
<div class="spec type extension">
<code><span><span class="keyword">type</span> <a href="#type-ext">ext</a> += </span></code>
<div class="spec type extension" id="extension-decl-ExtE">
<a href="#extension-decl-ExtE" class="anchor"></a><code><span><span class="keyword">type</span> <a href="#type-ext">ext</a> += </span></code>
<table>
<tbody>
<tr id="extension-ExtE" class="anchored">
Expand All @@ -1442,8 +1442,8 @@ <h4 id="advanced-type-stuff">
</div>
</div>
<div class="odoc-spec">
<div class="spec type extension">
<code><span><span class="keyword">type</span> <a href="#type-ext">ext</a> += </span></code>
<div class="spec type extension" id="extension-decl-ExtF">
<a href="#extension-decl-ExtF" class="anchor"></a><code><span><span class="keyword">type</span> <a href="#type-ext">ext</a> += </span></code>
<table>
<tbody>
<tr id="extension-ExtF" class="anchored">
Expand All @@ -1467,8 +1467,8 @@ <h4 id="advanced-type-stuff">
</div>
</div>
<div class="odoc-spec">
<div class="spec type extension">
<code><span><span class="keyword">type</span> <a href="#type-poly_ext">poly_ext</a> += </span></code>
<div class="spec type extension" id="extension-decl-Foo">
<a href="#extension-decl-Foo" class="anchor"></a><code><span><span class="keyword">type</span> <a href="#type-poly_ext">poly_ext</a> += </span></code>
<table>
<tbody>
<tr id="extension-Foo" class="anchored">
Expand All @@ -1494,8 +1494,8 @@ <h4 id="advanced-type-stuff">
</div>
</div>
<div class="odoc-spec">
<div class="spec type extension">
<code><span><span class="keyword">type</span> <a href="#type-poly_ext">poly_ext</a> += </span></code>
<div class="spec type extension" id="extension-decl-Quux">
<a href="#extension-decl-Quux" class="anchor"></a><code><span><span class="keyword">type</span> <a href="#type-poly_ext">poly_ext</a> += </span></code>
<table>
<tbody>
<tr id="extension-Quux" class="anchored">
Expand All @@ -1521,8 +1521,8 @@ <h4 id="advanced-type-stuff">
</div>
</div>
<div class="odoc-spec">
<div class="spec type extension">
<code><span><span class="keyword">type</span> <a href="ExtMod/index.html#type-t">ExtMod.t</a> += </span></code>
<div class="spec type extension" id="extension-decl-ZzzTop0">
<a href="#extension-decl-ZzzTop0" class="anchor"></a><code><span><span class="keyword">type</span> <a href="ExtMod/index.html#type-t">ExtMod.t</a> += </span></code>
<table>
<tbody>
<tr id="extension-ZzzTop0" class="anchored">
Expand All @@ -1543,8 +1543,8 @@ <h4 id="advanced-type-stuff">
</div>
</div>
<div class="odoc-spec">
<div class="spec type extension">
<code><span><span class="keyword">type</span> <a href="ExtMod/index.html#type-t">ExtMod.t</a> += </span></code>
<div class="spec type extension" id="extension-decl-ZzzTop">
<a href="#extension-decl-ZzzTop" class="anchor"></a><code><span><span class="keyword">type</span> <a href="ExtMod/index.html#type-t">ExtMod.t</a> += </span></code>
<table>
<tbody>
<tr id="extension-ZzzTop" class="anchored">
Expand Down Expand Up @@ -2013,8 +2013,8 @@ <h2 id="new-reference-syntax">
</div>
</div>
<div class="odoc-spec">
<div class="spec type extension">
<code><span><span class="keyword">type</span> <a href="#type-new_t">new_t</a> += </span></code>
<div class="spec type extension" id="extension-decl-C">
<a href="#extension-decl-C" class="anchor"></a><code><span><span class="keyword">type</span> <a href="#type-new_t">new_t</a> += </span></code>
<table>
<tbody>
<tr id="extension-C" class="anchored">
Expand Down
4 changes: 2 additions & 2 deletions test/html/expect/test_package+re/Type/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -482,8 +482,8 @@ <h1>
</div>
</div>
<div class="odoc-spec">
<div class="spec type extension">
<code><span><span class="keyword">type</span> <a href="#type-extensible">extensible</a> += </span></code>
<div class="spec type extension" id="extension-decl-Extension">
<a href="#extension-decl-Extension" class="anchor"></a><code><span><span class="keyword">type</span> <a href="#type-extensible">extensible</a> += </span></code>
<table>
<tbody>
<tr id="extension-Extension" class="anchored">
Expand Down
2 changes: 1 addition & 1 deletion test/latex/expect/test_package+ml/Type.tex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ \section{Module \ocamlinlinecode{Type}}\label{container-page-test+u+package+++ml
\label{container-page-test+u+package+++ml-module-Type-type-double+u+constrained}\ocamlcodefragment{\ocamltag{keyword}{type} ('a,\allowbreak{} 'b) double\_\allowbreak{}constrained = \ocamltag{type-var}{'a} * \ocamltag{type-var}{'b} \ocamltag{keyword}{constraint} \ocamltag{type-var}{'a} = int \ocamltag{keyword}{constraint} \ocamltag{type-var}{'b} = unit}\\
\label{container-page-test+u+package+++ml-module-Type-type-as+u+}\ocamlcodefragment{\ocamltag{keyword}{type} as\_\allowbreak{} = int \ocamltag{keyword}{as} 'a * \ocamltag{type-var}{'a}}\\
\label{container-page-test+u+package+++ml-module-Type-type-extensible}\ocamlcodefragment{\ocamltag{keyword}{type} extensible = .\allowbreak{}.\allowbreak{}}\\
\ocamlcodefragment{\ocamltag{keyword}{type} \hyperref[container-page-test+u+package+++ml-module-Type-type-extensible]{\ocamlinlinecode{extensible}} += }\\
\label{container-page-test+u+package+++ml-module-Type-extension-decl-Extension}\ocamlcodefragment{\ocamltag{keyword}{type} \hyperref[container-page-test+u+package+++ml-module-Type-type-extensible]{\ocamlinlinecode{extensible}} += }\\
\begin{ocamltabular}{p{0.500\textwidth}p{0.500\textwidth}}\ocamlcodefragment{| \ocamltag{extension}{Extension}}\label{container-page-test+u+package+++ml-module-Type-extension-Extension}& Documentation for \hyperref[container-page-test+u+package+++ml-module-Type-extension-Extension]{\ocamlinlinecode{\ocamlinlinecode{Extension}}[p\pageref*{container-page-test+u+package+++ml-module-Type-extension-Extension}]}.\\
\ocamlcodefragment{| \ocamltag{extension}{Another\_\allowbreak{}extension}}\label{container-page-test+u+package+++ml-module-Type-extension-Another+u+extension}& Documentation for \hyperref[container-page-test+u+package+++ml-module-Type-extension-Another+u+extension]{\ocamlinlinecode{\ocamlinlinecode{Another\_\allowbreak{}extension}}[p\pageref*{container-page-test+u+package+++ml-module-Type-extension-Another+u+extension}]}.\\
\end{ocamltabular}%
Expand Down