Add anchors to type extensions

This only adds the anchor in the html backend, it is not possible to reference type extensions. The anchor is "extension-decl-FirstConstructor". This should be enough because it is not possible to have two constructors of the same name in the same signature.
ocaml · Jun 9, 2021 · 7e3880a · 7e3880a
1 parent 92b3f1d
commit 7e3880a
Show file tree

Hide file tree

Showing 10 changed files with 63 additions and 50 deletions.
diff --git a/src/document/generator.ml b/src/document/generator.ml
@@ -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 }
 

diff --git a/src/document/url.ml b/src/document/url.ml
@@ -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

diff --git a/src/document/url.mli b/src/document/url.mli
@@ -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

diff --git a/test/html/expect/test_package+ml/Labels/index.html b/test/html/expect/test_package+ml/Labels/index.html
@@ -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">

diff --git a/test/html/expect/test_package+ml/Ocamlary/index.html b/test/html/expect/test_package+ml/Ocamlary/index.html
@@ -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">
@@ -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">
@@ -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">
@@ -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">
@@ -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">
@@ -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">
@@ -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">
@@ -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">
@@ -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">
@@ -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">

diff --git a/test/html/expect/test_package+ml/Type/index.html b/test/html/expect/test_package+ml/Type/index.html
@@ -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">

diff --git a/test/html/expect/test_package+re/Labels/index.html b/test/html/expect/test_package+re/Labels/index.html
@@ -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">

diff --git a/test/html/expect/test_package+re/Ocamlary/index.html b/test/html/expect/test_package+re/Ocamlary/index.html
@@ -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">
@@ -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">
@@ -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">
@@ -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">
@@ -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">
@@ -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">
@@ -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">
@@ -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">
@@ -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">
@@ -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">

diff --git a/test/html/expect/test_package+re/Type/index.html b/test/html/expect/test_package+re/Type/index.html
@@ -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">

diff --git a/test/latex/expect/test_package+ml/Type.tex b/test/latex/expect/test_package+ml/Type.tex
@@ -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}%