latex backend: full path in heading labels

src/latex/generator.ml

@@ -14,10 +14,10 @@ module Link = struct
 
   let page p = Format.asprintf "%a" flatten_path p
 
+  let anchor p a = Format.asprintf "%a-%s" flatten_path p a
+
   let label (x : Odoc_document.Url.t) =
-    match x.anchor with
-    | "" -> page x.page
-    | anchor -> Format.asprintf "%a-%s" flatten_path x.page anchor
+    match x.anchor with "" -> page x.page | a -> anchor x.page a
 
   let rec is_class_or_module_path (url : Odoc_document.Url.Path.t) =
     match url.kind with
@@ -264,9 +264,13 @@ and inline ~in_source ~verbatim (l : Inline.t) =
   in
   prettify l
 
-let heading (h : Heading.t) =
+let heading p (h : Heading.t) =
   let content = inline ~in_source:false ~verbatim:false h.title in
-  [ Section { label = h.label; level = h.level; content }; Break Aesthetic ]
+  [
+    Section
+      { label = Option.map (Link.anchor p) h.label; level = h.level; content };
+    Break Aesthetic;
+  ]
 
 let non_empty_block_code c =
   let s = source (inline ~verbatim:true ~in_source:true) c in
@@ -366,7 +370,7 @@ let rec documentedSrc (t : DocumentedSrc.t) =
          else non_empty_code_fragment e.summary)
         @ to_latex rest
     | Subpage subp :: rest ->
-        Indented (items subp.content.items) :: to_latex rest
+        Indented (items subp.content.url subp.content.items) :: to_latex rest
     | (Documented _ | Nested _) :: _ ->
         let take_descr l =
           Doctree.Take.until l ~classify:(function
@@ -408,10 +412,10 @@ let rec documentedSrc (t : DocumentedSrc.t) =
   in
   to_latex t
 
-and items l =
-  let rec walk_items ~only_text acc (t : Item.t list) =
+and items page_url l =
+  let rec walk_items ~page_url ~only_text acc (t : Item.t list) =
     let continue_with rest elts =
-      walk_items ~only_text (List.rev_append elts acc) rest
+      walk_items ~page_url ~only_text (List.rev_append elts acc) rest
     in
     match t with
     | [] -> List.rev acc
@@ -424,7 +428,7 @@ and items l =
         let content = block ~in_source:false text in
         let elts = content in
         elts |> continue_with rest
-    | Heading h :: rest -> heading h |> continue_with rest
+    | Heading h :: rest -> heading page_url h |> continue_with rest
     | Include
         {
           attr = _;
@@ -434,7 +438,7 @@ and items l =
           content = { summary; status = _; content };
         }
       :: rest ->
-        let included = items content in
+        let included = items page_url content in
         let docs = block ~in_source:true doc in
         let summary = source (inline ~verbatim:false ~in_source:true) summary in
         let content = included in
@@ -450,8 +454,10 @@ and items l =
               @ [ Indented (block ~in_source:true docs); Break Separation ]
         in
         continue_with rest elts
-  and items l = walk_items ~only_text:(is_only_text l) [] l in
-  items l
+  and items page_url l =
+    walk_items ~page_url ~only_text:(is_only_text l) [] l
+  in
+  items page_url l
 
 module Doc = struct
   let link_children ppf children =
@@ -492,8 +498,8 @@ module Page = struct
     and subpages = subpages ~with_children @@ Doctree.Subpages.compute p in
     let i = Doctree.Shift.compute ~on_sub i in
     let header, preamble = Doctree.PageTitle.render_title p in
-    let header = items (header @ preamble) in
-    let content = items i in
+    let header = items url (header @ preamble) in
+    let content = items url i in
     let page = Doc.make ~with_children url (header @ content) subpages in
     page
 end

test/generators/latex/Functor.F1.tex

@@ -1,9 +1,9 @@
 \section{Module \ocamlinlinecode{Functor.\allowbreak{}F1}}\label{Functor-F1}%
-\subsection{Parameters\label{parameters}}%
+\subsection{Parameters\label{Functor-F1-parameters}}%
 \label{Functor-F1-argument-1-Arg}\ocamlcodefragment{\ocamltag{keyword}{module} \hyperref[Functor-F1-argument-1-Arg]{\ocamlinlinecode{Arg}}}\ocamlcodefragment{ : \ocamltag{keyword}{sig}}\begin{ocamlindent}\label{Functor-F1-argument-1-Arg-type-t}\ocamlcodefragment{\ocamltag{keyword}{type} t}\\
 \end{ocamlindent}%
 \ocamlcodefragment{\ocamltag{keyword}{end}}\\
-\subsection{Signature\label{signature}}%
+\subsection{Signature\label{Functor-F1-signature}}%
 \label{Functor-F1-type-t}\ocamlcodefragment{\ocamltag{keyword}{type} t}\\
 
 

test/generators/latex/Functor.F2.tex

@@ -1,9 +1,9 @@
 \section{Module \ocamlinlinecode{Functor.\allowbreak{}F2}}\label{Functor-F2}%
-\subsection{Parameters\label{parameters}}%
+\subsection{Parameters\label{Functor-F2-parameters}}%
 \label{Functor-F2-argument-1-Arg}\ocamlcodefragment{\ocamltag{keyword}{module} \hyperref[Functor-F2-argument-1-Arg]{\ocamlinlinecode{Arg}}}\ocamlcodefragment{ : \ocamltag{keyword}{sig}}\begin{ocamlindent}\label{Functor-F2-argument-1-Arg-type-t}\ocamlcodefragment{\ocamltag{keyword}{type} t}\\
 \end{ocamlindent}%
 \ocamlcodefragment{\ocamltag{keyword}{end}}\\
-\subsection{Signature\label{signature}}%
+\subsection{Signature\label{Functor-F2-signature}}%
 \label{Functor-F2-type-t}\ocamlcodefragment{\ocamltag{keyword}{type} t = \hyperref[Functor-F2-argument-1-Arg-type-t]{\ocamlinlinecode{Arg.\allowbreak{}t}}}\\
 
 

test/generators/latex/Functor.F3.tex

@@ -1,9 +1,9 @@
 \section{Module \ocamlinlinecode{Functor.\allowbreak{}F3}}\label{Functor-F3}%
-\subsection{Parameters\label{parameters}}%
+\subsection{Parameters\label{Functor-F3-parameters}}%
 \label{Functor-F3-argument-1-Arg}\ocamlcodefragment{\ocamltag{keyword}{module} \hyperref[Functor-F3-argument-1-Arg]{\ocamlinlinecode{Arg}}}\ocamlcodefragment{ : \ocamltag{keyword}{sig}}\begin{ocamlindent}\label{Functor-F3-argument-1-Arg-type-t}\ocamlcodefragment{\ocamltag{keyword}{type} t}\\
 \end{ocamlindent}%
 \ocamlcodefragment{\ocamltag{keyword}{end}}\\
-\subsection{Signature\label{signature}}%
+\subsection{Signature\label{Functor-F3-signature}}%
 \label{Functor-F3-type-t}\ocamlcodefragment{\ocamltag{keyword}{type} t = \hyperref[Functor-F3-argument-1-Arg-type-t]{\ocamlinlinecode{Arg.\allowbreak{}t}}}\\
 
 

test/generators/latex/Functor.F4.tex

@@ -1,9 +1,9 @@
 \section{Module \ocamlinlinecode{Functor.\allowbreak{}F4}}\label{Functor-F4}%
-\subsection{Parameters\label{parameters}}%
+\subsection{Parameters\label{Functor-F4-parameters}}%
 \label{Functor-F4-argument-1-Arg}\ocamlcodefragment{\ocamltag{keyword}{module} \hyperref[Functor-F4-argument-1-Arg]{\ocamlinlinecode{Arg}}}\ocamlcodefragment{ : \ocamltag{keyword}{sig}}\begin{ocamlindent}\label{Functor-F4-argument-1-Arg-type-t}\ocamlcodefragment{\ocamltag{keyword}{type} t}\\
 \end{ocamlindent}%
 \ocamlcodefragment{\ocamltag{keyword}{end}}\\
-\subsection{Signature\label{signature}}%
+\subsection{Signature\label{Functor-F4-signature}}%
 \label{Functor-F4-type-t}\ocamlcodefragment{\ocamltag{keyword}{type} t}\\
 
 

test/generators/latex/Functor.F5.tex

@@ -1,6 +1,6 @@
 \section{Module \ocamlinlinecode{Functor.\allowbreak{}F5}}\label{Functor-F5}%
-\subsection{Parameters\label{parameters}}%
-\subsection{Signature\label{signature}}%
+\subsection{Parameters\label{Functor-F5-parameters}}%
+\subsection{Signature\label{Functor-F5-signature}}%
 \label{Functor-F5-type-t}\ocamlcodefragment{\ocamltag{keyword}{type} t}\\
 
 

test/generators/latex/Functor.tex

@@ -2,11 +2,11 @@ \section{Module \ocamlinlinecode{Functor}}\label{Functor}%
 \label{Functor-module-type-S}\ocamlcodefragment{\ocamltag{keyword}{module} \ocamltag{keyword}{type} \hyperref[Functor-module-type-S]{\ocamlinlinecode{S}}}\ocamlcodefragment{ = \ocamltag{keyword}{sig}}\begin{ocamlindent}\label{Functor-module-type-S-type-t}\ocamlcodefragment{\ocamltag{keyword}{type} t}\\
 \end{ocamlindent}%
 \ocamlcodefragment{\ocamltag{keyword}{end}}\\
-\label{Functor-module-type-S1}\ocamlcodefragment{\ocamltag{keyword}{module} \ocamltag{keyword}{type} \hyperref[Functor-module-type-S1]{\ocamlinlinecode{S1}}}\ocamlcodefragment{ = \ocamltag{keyword}{sig}}\begin{ocamlindent}\subsubsection{Parameters\label{parameters}}%
+\label{Functor-module-type-S1}\ocamlcodefragment{\ocamltag{keyword}{module} \ocamltag{keyword}{type} \hyperref[Functor-module-type-S1]{\ocamlinlinecode{S1}}}\ocamlcodefragment{ = \ocamltag{keyword}{sig}}\begin{ocamlindent}\subsubsection{Parameters\label{Functor-module-type-S1-parameters}}%
 \label{Functor-module-type-S1-argument-1-_}\ocamlcodefragment{\ocamltag{keyword}{module} \hyperref[Functor-module-type-S1-argument-1-_]{\ocamlinlinecode{\_\allowbreak{}}}}\ocamlcodefragment{ : \ocamltag{keyword}{sig}}\begin{ocamlindent}\label{Functor-module-type-S1-argument-1-_-type-t}\ocamlcodefragment{\ocamltag{keyword}{type} t}\\
 \end{ocamlindent}%
 \ocamlcodefragment{\ocamltag{keyword}{end}}\\
-\subsubsection{Signature\label{signature}}%
+\subsubsection{Signature\label{Functor-module-type-S1-signature}}%
 \label{Functor-module-type-S1-type-t}\ocamlcodefragment{\ocamltag{keyword}{type} t}\\
 \end{ocamlindent}%
 \ocamlcodefragment{\ocamltag{keyword}{end}}\\

test/generators/latex/Functor2.X.tex

@@ -1,12 +1,12 @@
 \section{Module \ocamlinlinecode{Functor2.\allowbreak{}X}}\label{Functor2-X}%
-\subsection{Parameters\label{parameters}}%
+\subsection{Parameters\label{Functor2-X-parameters}}%
 \label{Functor2-X-argument-1-Y}\ocamlcodefragment{\ocamltag{keyword}{module} \hyperref[Functor2-X-argument-1-Y]{\ocamlinlinecode{Y}}}\ocamlcodefragment{ : \ocamltag{keyword}{sig}}\begin{ocamlindent}\label{Functor2-X-argument-1-Y-type-t}\ocamlcodefragment{\ocamltag{keyword}{type} t}\\
 \end{ocamlindent}%
 \ocamlcodefragment{\ocamltag{keyword}{end}}\\
 \label{Functor2-X-argument-2-Z}\ocamlcodefragment{\ocamltag{keyword}{module} \hyperref[Functor2-X-argument-2-Z]{\ocamlinlinecode{Z}}}\ocamlcodefragment{ : \ocamltag{keyword}{sig}}\begin{ocamlindent}\label{Functor2-X-argument-2-Z-type-t}\ocamlcodefragment{\ocamltag{keyword}{type} t}\\
 \end{ocamlindent}%
 \ocamlcodefragment{\ocamltag{keyword}{end}}\\
-\subsection{Signature\label{signature}}%
+\subsection{Signature\label{Functor2-X-signature}}%
 \label{Functor2-X-type-y_t}\ocamlcodefragment{\ocamltag{keyword}{type} y\_\allowbreak{}t = \hyperref[Functor2-X-argument-1-Y-type-t]{\ocamlinlinecode{Y.\allowbreak{}t}}}\\
 \label{Functor2-X-type-z_t}\ocamlcodefragment{\ocamltag{keyword}{type} z\_\allowbreak{}t = \hyperref[Functor2-X-argument-2-Z-type-t]{\ocamlinlinecode{Z.\allowbreak{}t}}}\\
 \label{Functor2-X-type-x_t}\ocamlcodefragment{\ocamltag{keyword}{type} x\_\allowbreak{}t = \hyperref[Functor2-X-type-y_t]{\ocamlinlinecode{y\_\allowbreak{}t}}}\\

test/generators/latex/Functor2.tex

@@ -3,14 +3,14 @@ \section{Module \ocamlinlinecode{Functor2}}\label{Functor2}%
 \end{ocamlindent}%
 \ocamlcodefragment{\ocamltag{keyword}{end}}\\
 \label{Functor2-module-X}\ocamlcodefragment{\ocamltag{keyword}{module} \hyperref[Functor2-X]{\ocamlinlinecode{X}}}\ocamlcodefragment{ (\hyperref[Functor2-X-argument-1-Y]{\ocamlinlinecode{Y}} : \hyperref[Functor2-module-type-S]{\ocamlinlinecode{S}}) (\hyperref[Functor2-X-argument-2-Z]{\ocamlinlinecode{Z}} : \hyperref[Functor2-module-type-S]{\ocamlinlinecode{S}}) : \ocamltag{keyword}{sig} .\allowbreak{}.\allowbreak{}.\allowbreak{} \ocamltag{keyword}{end}}\\
-\label{Functor2-module-type-XF}\ocamlcodefragment{\ocamltag{keyword}{module} \ocamltag{keyword}{type} \hyperref[Functor2-module-type-XF]{\ocamlinlinecode{XF}}}\ocamlcodefragment{ = \ocamltag{keyword}{sig}}\begin{ocamlindent}\subsubsection{Parameters\label{parameters_2}}%
+\label{Functor2-module-type-XF}\ocamlcodefragment{\ocamltag{keyword}{module} \ocamltag{keyword}{type} \hyperref[Functor2-module-type-XF]{\ocamlinlinecode{XF}}}\ocamlcodefragment{ = \ocamltag{keyword}{sig}}\begin{ocamlindent}\subsubsection{Parameters\label{Functor2-module-type-XF-parameters_2}}%
 \label{Functor2-module-type-XF-argument-1-Y}\ocamlcodefragment{\ocamltag{keyword}{module} \hyperref[Functor2-module-type-XF-argument-1-Y]{\ocamlinlinecode{Y}}}\ocamlcodefragment{ : \ocamltag{keyword}{sig}}\begin{ocamlindent}\label{Functor2-module-type-XF-argument-1-Y-type-t}\ocamlcodefragment{\ocamltag{keyword}{type} t}\\
 \end{ocamlindent}%
 \ocamlcodefragment{\ocamltag{keyword}{end}}\\
 \label{Functor2-module-type-XF-argument-2-Z}\ocamlcodefragment{\ocamltag{keyword}{module} \hyperref[Functor2-module-type-XF-argument-2-Z]{\ocamlinlinecode{Z}}}\ocamlcodefragment{ : \ocamltag{keyword}{sig}}\begin{ocamlindent}\label{Functor2-module-type-XF-argument-2-Z-type-t}\ocamlcodefragment{\ocamltag{keyword}{type} t}\\
 \end{ocamlindent}%
 \ocamlcodefragment{\ocamltag{keyword}{end}}\\
-\subsubsection{Signature\label{signature_2}}%
+\subsubsection{Signature\label{Functor2-module-type-XF-signature_2}}%
 \label{Functor2-module-type-XF-type-y_t}\ocamlcodefragment{\ocamltag{keyword}{type} y\_\allowbreak{}t = \hyperref[Functor2-module-type-XF-argument-1-Y-type-t]{\ocamlinlinecode{Y.\allowbreak{}t}}}\\
 \label{Functor2-module-type-XF-type-z_t}\ocamlcodefragment{\ocamltag{keyword}{type} z\_\allowbreak{}t = \hyperref[Functor2-module-type-XF-argument-2-Z-type-t]{\ocamlinlinecode{Z.\allowbreak{}t}}}\\
 \label{Functor2-module-type-XF-type-x_t}\ocamlcodefragment{\ocamltag{keyword}{type} x\_\allowbreak{}t = \hyperref[Functor2-module-type-XF-type-y_t]{\ocamlinlinecode{y\_\allowbreak{}t}}}\\

test/generators/latex/Functor_ml.Foo'.tex

@@ -1,9 +1,9 @@
 \section{Module \ocamlinlinecode{Functor\_\allowbreak{}ml.\allowbreak{}Foo'}}\label{Functor_ml-Foo'}%
-\subsection{Parameters\label{parameters}}%
+\subsection{Parameters\label{Functor_ml-Foo'-parameters}}%
 \label{Functor_ml-Foo'-argument-1-X}\ocamlcodefragment{\ocamltag{keyword}{module} \hyperref[Functor_ml-Foo'-argument-1-X]{\ocamlinlinecode{X}}}\ocamlcodefragment{ : \ocamltag{keyword}{sig}}\begin{ocamlindent}\label{Functor_ml-Foo'-argument-1-X-val-foo}\ocamlcodefragment{\ocamltag{keyword}{val} foo : int}\\
 \end{ocamlindent}%
 \ocamlcodefragment{\ocamltag{keyword}{end}}\\
-\subsection{Signature\label{signature}}%
+\subsection{Signature\label{Functor_ml-Foo'-signature}}%
 \label{Functor_ml-Foo'-type-t}\ocamlcodefragment{\ocamltag{keyword}{type} t = \hyperref[Functor_ml-Bar-type-t]{\ocamlinlinecode{Bar.\allowbreak{}t}}}\\
 
 

test/generators/latex/Include_sections.tex

@@ -1,58 +1,58 @@
 \section{Module \ocamlinlinecode{Include\_\allowbreak{}sections}}\label{Include_sections}%
 \label{Include_sections-module-type-Something}\ocamlcodefragment{\ocamltag{keyword}{module} \ocamltag{keyword}{type} \hyperref[Include_sections-module-type-Something]{\ocamlinlinecode{Something}}}\ocamlcodefragment{ = \ocamltag{keyword}{sig}}\begin{ocamlindent}\label{Include_sections-module-type-Something-val-something}\ocamlcodefragment{\ocamltag{keyword}{val} something : unit}\\
-\subsubsection{Something 1\label{something-1}}%
+\subsubsection{Something 1\label{Include_sections-module-type-Something-something-1}}%
 foo
 
 \label{Include_sections-module-type-Something-val-foo}\ocamlcodefragment{\ocamltag{keyword}{val} foo : unit}\\
-\subsubsection{Something 2\label{something-2}}%
+\subsubsection{Something 2\label{Include_sections-module-type-Something-something-2}}%
 \label{Include_sections-module-type-Something-val-bar}\ocamlcodefragment{\ocamltag{keyword}{val} bar : unit}\begin{ocamlindent}foo bar\end{ocamlindent}%
 \medbreak
-\subsubsection{Something 1-bis\label{something-1-bis}}%
+\subsubsection{Something 1-bis\label{Include_sections-module-type-Something-something-1-bis}}%
 Some text.
 
 \end{ocamlindent}%
 \ocamlcodefragment{\ocamltag{keyword}{end}}\begin{ocamlindent}A module type.\end{ocamlindent}%
 \medbreak
 Let's include \hyperref[Include_sections-module-type-Something]{\ocamlinlinecode{\ocamlinlinecode{Something}}[p\pageref*{Include_sections-module-type-Something}]} once
 
-\ocamltag{keyword}{include} \hyperref[Include_sections-module-type-Something]{\ocamlinlinecode{Something}}\subsection{Something 1\label{something-1_2}}%
+\ocamltag{keyword}{include} \hyperref[Include_sections-module-type-Something]{\ocamlinlinecode{Something}}\subsection{Something 1\label{Include_sections-something-1_2}}%
 foo
 
-\subsubsection{Something 2\label{something-2_2}}%
-\subsection{Something 1-bis\label{something-1-bis_2}}%
+\subsubsection{Something 2\label{Include_sections-something-2_2}}%
+\subsection{Something 1-bis\label{Include_sections-something-1-bis_2}}%
 Some text.
 
-\subsection{Second include\label{second-include}}%
+\subsection{Second include\label{Include_sections-second-include}}%
 Let's include \hyperref[Include_sections-module-type-Something]{\ocamlinlinecode{\ocamlinlinecode{Something}}[p\pageref*{Include_sections-module-type-Something}]} a second time: the heading level should be shift here.
 
-\ocamltag{keyword}{include} \hyperref[Include_sections-module-type-Something]{\ocamlinlinecode{Something}}\subsection{Something 1\label{something-1_3}}%
+\ocamltag{keyword}{include} \hyperref[Include_sections-module-type-Something]{\ocamlinlinecode{Something}}\subsection{Something 1\label{Include_sections-something-1_3}}%
 foo
 
-\subsubsection{Something 2\label{something-2_3}}%
-\subsection{Something 1-bis\label{something-1-bis_3}}%
+\subsubsection{Something 2\label{Include_sections-something-2_3}}%
+\subsection{Something 1-bis\label{Include_sections-something-1-bis_3}}%
 Some text.
 
-\subsubsection{Third include\label{third-include}}%
+\subsubsection{Third include\label{Include_sections-third-include}}%
 Shifted some more.
 
-\ocamltag{keyword}{include} \hyperref[Include_sections-module-type-Something]{\ocamlinlinecode{Something}}\subsection{Something 1\label{something-1_4}}%
+\ocamltag{keyword}{include} \hyperref[Include_sections-module-type-Something]{\ocamlinlinecode{Something}}\subsection{Something 1\label{Include_sections-something-1_4}}%
 foo
 
-\subsubsection{Something 2\label{something-2_4}}%
-\subsection{Something 1-bis\label{something-1-bis_4}}%
+\subsubsection{Something 2\label{Include_sections-something-2_4}}%
+\subsection{Something 1-bis\label{Include_sections-something-1-bis_4}}%
 Some text.
 
 And let's include it again, but without inlining it this time: the ToC shouldn't grow.
 
 \ocamltag{keyword}{include} \hyperref[Include_sections-module-type-Something]{\ocamlinlinecode{Something}}\label{Include_sections-val-something}\ocamlcodefragment{\ocamltag{keyword}{val} something : unit}\\
-\subsection{Something 1\label{something-1_5}}%
+\subsection{Something 1\label{Include_sections-something-1_5}}%
 foo
 
 \label{Include_sections-val-foo}\ocamlcodefragment{\ocamltag{keyword}{val} foo : unit}\\
-\subsubsection{Something 2\label{something-2_5}}%
+\subsubsection{Something 2\label{Include_sections-something-2_5}}%
 \label{Include_sections-val-bar}\ocamlcodefragment{\ocamltag{keyword}{val} bar : unit}\begin{ocamlindent}foo bar\end{ocamlindent}%
 \medbreak
-\subsection{Something 1-bis\label{something-1-bis_5}}%
+\subsection{Something 1-bis\label{Include_sections-something-1-bis_5}}%
 Some text.
 
 

test/generators/latex/Labels.c.tex

@@ -1,4 +1,4 @@
 \section{Class \ocamlinlinecode{Labels.\allowbreak{}c}}\label{Labels-class-c}%
-\subsection{Attached to class\label{L7}}%
+\subsection{Attached to class\label{Labels-class-c-L7}}%