Ocaml 5.5 compat by panglesd · Pull Request #1406 · ocaml/odoc

panglesd · 2026-03-25T16:25:07Z

Support for 5.5 with:

Support for external types, displayed as abstract types
Support for module arrows.

The second one is trickier. In this PR, at least:

The type is written
There is no warning about missing elements from the environment.

However, the path referencing the module argument appear as unresolved links: underlined in red, suggesting an error...

The state of the PR is draft because it needs to be cleaned up and improved, but I already open it in case someone wants to try odoc on OCaml 5.5.

🤖 Generated with @xvw

jonludlam · 2026-04-07T15:19:00Z

 depends: [
  "dune" {>= "3.21"}
-  "ocaml" {>= "4.08.0" & < "5.5"}
+  "ocaml" {>= "4.08.0" & <= "5.5.1"}


This one too!

Actually thinking about it, why do we have an upper bound on odoc-parser? I can understand with odoc where every ocaml release breaks it, but the parser ought to be way less brittle.

I agree, there is no reason to have this "minor release" upper bound!

panglesd · 2026-04-08T16:08:06Z

I'd still like to clean the history, but the PR is ready for review.

Octachron · 2026-04-09T14:12:20Z

+
+val g' : (module M : Y) -> int
+
+val g'' : (module Y) -> int


You should probably also add a test for polymorphic parameters:

val map2: ('a. 'a -> 'a) -> 'a * 'b -> 'a * 'b

after a quick look, I have the impression that the current document generation code is missing parentheses.

Thanks! I'll add that today.

I cherry-picked @art-w's 0752cc5 which fixed exactly that (thanks!).

@art-w I did not include the Oxcaml test since it is not part of "5.5 support". Whichever is merged last, #1404 or this one, will have to rebase!

panglesd · 2026-04-13T16:40:09Z

I'd still like to clean the history

I rebased and cleaned the history. (And addressed ochtachron's comment)

- pack_cstrs renamed to pack_constraints in Types.package - tpt_cstrs renamed to tpt_constraints in Typedtree.package_type - typ_cstrs renamed to typ_constraints in Typedtree.type_declaration - New Type_external/Ttype_external constructors for external types - New Tfunctor/Ttyp_functor constructors in type_desc/core_type_desc - New Local_opaque_item constructor in Shape.Uid - Typemod.path_of_module moved to Typedtree.path_of_module Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

The way it works is not ideal: we create a synthetic parent id for each module argument (as they can be introduced multiple times with the same name in the same type expression). This id is hidden and we don't render links to hidden ids. This is slightly bad because: - The appearance of unresolved links suggest an error when there is no. - There is no way to distinguish module args from normal modules But let's say it is a good first step! Co-authored-by: xvw <xavier.vdw@gmail.com>

Co-authored-by: Kate <kit-ty-kate@exn.st>

panglesd · 2026-04-15T09:22:52Z

Rebased since the merge of #1404

xvw

For what it's worth, and judging by the output results!

Octachron · 2026-04-15T11:51:38Z

On the subject of the module argument, I was wondering if it would not better to link M.t in (module M:T) -> M.t
to the t component of the module type since at least for now the module type of a module argument is always a named module.

Nevertheless, I agree that this can be improved later.

panglesd · 2026-04-15T13:34:40Z

On the subject of the module argument, I was wondering if it would not better to link M.t in (module M:T) -> M.t
to the t component of the module type since at least for now the module type of a module argument is always a named module.

Would you link the same way when the type is replaced?

module type S =  sig type t = float end

val f : (module M : S with type t = int) -> M.t

I would find it misleading! The way to improve I can think of are too involved for this initial support...

Octachron · 2026-04-15T13:39:23Z

Your example is a type error, thus I am not sure how illustrative it is.
The constraints can only refine an abstract type:

module type S = sig type t end
val f : (module M : S with type t = int) -> M.t

in which case is not that clear what is the best option between linking to M.t or int, but following the intent
of the author that wrote M.t rather than t does not sound that bad.

Anyway, I agree that this is probably best left for further refinement.

jonludlam · 2026-04-16T16:17:55Z

Looks good! I came across some test failures when I was looking through it though, so I've fixed them (very minor). As soon as CI shows green we'll merge!

@dlesbre

CHANGES: - Allow persistent latex macros in HTML/KaTeX backend (@dlesbre, ocaml/odoc#1391) - `markdown-generate` command now accepts multiple `.odocl` files in a single invocation, eliminating the need for shell scripting (@davesnx, ocaml/odoc#1387) - Support for OxCaml (@lukemaurer, @art-w, ocaml/odoc#1399) - OCaml 5.5.0 support (@panglesd, @xvw, ocaml/odoc#1406) - Fix compile-time crashing bugs ocaml/odoc#930 and ocaml/odoc#1385 (@jonludlam, ocaml/odoc#1400) - Markdown backend assumes ocaml as langId on declarations - Markdown backend collects all code snippets and render a single code block with comments, rather than split the variants/records per constructor/field - Fix URL remapping for page references (@jonludlam, ocaml/odoc#1395) - Fix ocaml/odoc#1396, which broke incrememntal builds (@jonludlam, ocaml/odoc#1402) - Ensure all warnings turn into errors with --warn-error (@jonludlam, ocaml/odoc#1402) - Fix missing parentheses for polymorphic arguments (@art-w, ocaml/odoc#1404)

panglesd mentioned this pull request Mar 25, 2026

OCaml 5.5 support #1401

Open

kit-ty-kate reviewed Mar 25, 2026

View reviewed changes

Comment thread odoc.opam Outdated

jonludlam reviewed Apr 7, 2026

View reviewed changes

panglesd force-pushed the ocaml-5.5-compat branch 4 times, most recently from 4415c76 to 54a3814 Compare April 8, 2026 15:53

panglesd added a commit to panglesd/odoc that referenced this pull request Apr 8, 2026

Add changelog entry for ocaml#1406

9a3678f

panglesd marked this pull request as ready for review April 8, 2026 16:07

Octachron reviewed Apr 9, 2026

View reviewed changes

panglesd force-pushed the ocaml-5.5-compat branch from 9a3678f to 4201c48 Compare April 13, 2026 16:23

panglesd added a commit to panglesd/odoc that referenced this pull request Apr 13, 2026

Add changelog entry for ocaml#1406

4201c48

panglesd added a commit to panglesd/odoc that referenced this pull request Apr 13, 2026

Add changelog entry for ocaml#1406

9bd4411

panglesd force-pushed the ocaml-5.5-compat branch from f91e2ab to cdadeff Compare April 13, 2026 16:38

Jon Ludlam's Agent and others added 8 commits April 15, 2026 11:20

Update odoc.opam

1fd7d1c

Co-authored-by: Kate <kit-ty-kate@exn.st>

Add missing test output

b1f0b25

Add constraint on 5.5 test

0db4523

Remove odoc-parser upper bound on ocaml version

4c2023d

Add changelog entry for ocaml#1406

a90cc6e

Add test for polymorphic argument in 5.5

fdf71a2

panglesd force-pushed the ocaml-5.5-compat branch from cdadeff to fdf71a2 Compare April 15, 2026 09:22

xvw approved these changes Apr 15, 2026

View reviewed changes

Octachron mentioned this pull request Apr 16, 2026

OCaml 5.5.0 release readiness ocaml/opam-repository#29463

Open

18 tasks

jonludlam added 2 commits April 16, 2026 16:32

Promote tests

baa1bbf

Don't rely on the output of cmdliner errors in tests

3c1811b

jonludlam merged commit 4fa086b into ocaml:master Apr 17, 2026
11 checks passed

jonludlam pushed a commit that referenced this pull request Apr 17, 2026

Add changelog entry for #1406

3e766a3

jonludlam mentioned this pull request May 1, 2026

[new release] odoc (5 packages) (3.2.0) ocaml/opam-repository#29834

Closed

Conversation

panglesd commented Mar 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

jonludlam Apr 7, 2026

Choose a reason for hiding this comment

Uh oh!

jonludlam Apr 7, 2026

Choose a reason for hiding this comment

Uh oh!

panglesd Apr 8, 2026

Choose a reason for hiding this comment

Uh oh!

panglesd commented Apr 8, 2026

Uh oh!

Octachron Apr 9, 2026

Choose a reason for hiding this comment

Uh oh!

panglesd Apr 13, 2026

Choose a reason for hiding this comment

Uh oh!

panglesd Apr 13, 2026

Choose a reason for hiding this comment

Uh oh!

panglesd commented Apr 13, 2026

Uh oh!

panglesd commented Apr 15, 2026

Uh oh!

xvw left a comment

Choose a reason for hiding this comment

Uh oh!

Octachron commented Apr 15, 2026

Uh oh!

panglesd commented Apr 15, 2026

Uh oh!

Octachron commented Apr 15, 2026

Uh oh!

jonludlam commented Apr 16, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

panglesd commented Mar 25, 2026 •

edited

Loading