Merge pull request #1060 from Julow/compat-402

Compatibility with 4.02

Author: Julow

.github/workflows/build.yml

@@ -10,15 +10,22 @@ jobs:
     strategy:
       matrix:
         os:
-          - macos-latest
           - ubuntu-latest
-          # - windows-latest Windows doesn't work yet
         ocaml-compiler:
-          # Don't include every versions. OCaml-CI already covers that
+          - 4.02.x
+          - 4.04.x
+          - 4.06.x
+          - 4.08.x
+          - 4.10.x
+          - 4.12.x
           - 4.14.x
         include:
-          - os: ubuntu-latest # Enable coverage only on a single build
+          - os: ubuntu-latest
+            ocaml-compiler: 4.14.x
+            # We don't need to compute coverage for more than one build
             send-coverage: true
+            # Mdx tests Mdx tests
+            run-mdx: true
       fail-fast: false
 
     runs-on: ${{ matrix.os }}
@@ -40,21 +47,19 @@ jobs:
       - name: Install dependencies
         run: opam install -y --deps-only -t ./odoc.opam ./odoc-parser.opam
 
-      - name: Install bisect_ppx
-        run: opam install bisect_ppx
-
       - name: dune runtest
         run: opam exec -- dune runtest
 
-      # Run Mdx tests that are disabled by default.
       - name: Mdx tests
+        if: matrix.run-mdx == true
         run: |
           opam install -y mdx
           opam exec -- dune build @runmdx
 
       - name: Send coverage stats to Coveralls
         if: matrix.send-coverage == true
         run: |
+          opam install bisect_ppx
           opam exec -- dune runtest --instrument-with bisect_ppx --force
           opam exec -- bisect-ppx-report send-to Coveralls
         env:

src/html/config.mli

@@ -3,9 +3,7 @@
 type t
 
 val v :
-  ?search_result:bool
-    (** Indicates whether this is a summary for a search result.
-     In that case, the links will be printed as regular text. *) ->
+  ?search_result:bool ->
   ?theme_uri:Types.uri ->
   ?support_uri:Types.uri ->
   ?search_uris:Types.file_uri list ->
@@ -16,6 +14,8 @@ val v :
   as_json:bool ->
   unit ->
   t
+(** [search_result] indicates whether this is a summary for a search result. In
+    that case, the links will be printed as regular text. *)
 
 val theme_uri : t -> Types.uri
 

src/html_support_files/dune

@@ -3,8 +3,6 @@
 
 (rule
  (aliases runtest support-files)
- (enabled_if
-  (> %{ocaml_version} 4.08))
  (target odoc_html_support_files.ml)
  (deps
   (glob_files *.js)
@@ -29,8 +27,7 @@
     -o
     odoc_html_support_files.ml
     -m
-    plain
-    -s))))
+    plain))))
 
 (library
  (name odoc_html_support_files)

src/odoc/bin/main.ml

@@ -405,7 +405,7 @@ module Indexing = struct
     let output = output_file ~dst in
     match (inputs_in_file, inputs) with
     | [], [] ->
-        Error
+        Result.Error
           (`Msg
             "At least one of --file-list or an .odocl file must be passed to \
              odoc compile-index")
@@ -762,8 +762,7 @@ module Odoc_html_args = struct
              else Relative (conv_rel_file str))
       in
       let printer ppf = function
-        | Odoc_html.Types.((Absolute uri : file_uri)) ->
-            Format.pp_print_string ppf uri
+        | Odoc_html.Types.Absolute uri -> Format.pp_print_string ppf uri
         | Odoc_html.Types.Relative _uri -> Format.pp_print_string ppf ""
       in
       (parser, printer)

src/search/html.ml

@@ -14,7 +14,7 @@ let url id =
           ~indent:false ~flat:false ~open_details:false ~as_json:false ()
       in
       let url = Odoc_html.Link.href ~config ~resolve:(Base "") url in
-      Ok url
+      Result.Ok url
   | Error _ as e -> e
 
 let map_option f = function Some x -> Some (f x) | None -> None

src/search/html.mli

@@ -6,7 +6,7 @@ val of_entry : Entry.t -> html list
 
 val url :
   Odoc_model.Paths.Identifier.Any.t ->
-  (string, Odoc_document.Url.Error.t) result
+  (string, Odoc_document.Url.Error.t) Result.result
 
 (** The below is intended for search engine that do not use the Json output but
     Odoc as a library. Most search engine will use their own representation 

src/search/json_index/json_display.ml

@@ -2,12 +2,12 @@ open Odoc_search
 
 let of_entry { Entry.id; doc = _; kind = _ } h =
   match Html.url id with
-  | Ok url ->
+  | Result.Ok url ->
       let html =
         h
         |> List.map (fun html ->
                Format.asprintf "%a" (Tyxml.Html.pp_elt ()) html)
         |> String.concat ""
       in
-      Ok (`Object [ ("url", `String url); ("html", `String html) ])
+      Result.Ok (`Object [ ("url", `String url); ("html", `String html) ])
   | Error _ as e -> e

src/search/json_index/json_display.mli

@@ -3,4 +3,4 @@ open Odoc_search
 val of_entry :
   Entry.t ->
   Html.html list ->
-  (Odoc_html.Json.json, Odoc_document.Url.Error.t) result
+  (Odoc_html.Json.json, Odoc_document.Url.Error.t) Result.result

src/search/json_index/json_search.ml

@@ -168,8 +168,8 @@ let of_entry ({ Entry.id; doc; kind } as entry) html =
           ]
   in
   match Json_display.of_entry entry html with
-  | Ok display ->
-      Ok
+  | Result.Ok display ->
+      Result.Ok
         (`Object
           [ ("id", j_id); ("doc", doc); ("kind", kind); ("display", display) ])
   | Error _ as e -> e

src/xref2/compile.ml

@@ -21,26 +21,26 @@ let type_path : Env.t -> Paths.Path.Type.t -> Paths.Path.Type.t =
       | Ok p' -> `Resolved Lang_of.(Path.resolved_type (empty ()) p')
       | Error _ -> p)
 
-and value_path : Env.t -> Paths.Path.Value.t -> Paths.Path.Value.t =
- fun env p ->
-  match p with
-  | `Resolved _ -> p
-  | _ -> (
-      let cp = Component.Of_Lang.(value_path (empty ()) p) in
-      match Tools.resolve_value_path env cp with
-      | Ok p' -> `Resolved Lang_of.(Path.resolved_value (empty ()) p')
-      | Error _ -> p)
-
-and constructor_path :
-    Env.t -> Paths.Path.Constructor.t -> Paths.Path.Constructor.t =
- fun env p ->
-  match p with
-  | `Resolved _ -> p
-  | _ -> (
-      let cp = Component.Of_Lang.(constructor_path (empty ()) p) in
-      match Tools.resolve_constructor_path env cp with
-      | Ok p' -> `Resolved Lang_of.(Path.resolved_constructor (empty ()) p')
-      | Error _ -> p)
+(* and value_path : Env.t -> Paths.Path.Value.t -> Paths.Path.Value.t = *)
+(*  fun env p -> *)
+(*   match p with *)
+(*   | `Resolved _ -> p *)
+(*   | _ -> ( *)
+(*       let cp = Component.Of_Lang.(value_path (empty ()) p) in *)
+(*       match Tools.resolve_value_path env cp with *)
+(*       | Ok p' -> `Resolved Lang_of.(Path.resolved_value (empty ()) p') *)
+(*       | Error _ -> p) *)
+
+(* and constructor_path : *)
+(*     Env.t -> Paths.Path.Constructor.t -> Paths.Path.Constructor.t = *)
+(*  fun env p -> *)
+(*   match p with *)
+(*   | `Resolved _ -> p *)
+(*   | _ -> ( *)
+(*       let cp = Component.Of_Lang.(constructor_path (empty ()) p) in *)
+(*       match Tools.resolve_constructor_path env cp with *)
+(*       | Ok p' -> `Resolved Lang_of.(Path.resolved_constructor (empty ()) p') *)
+(*       | Error _ -> p) *)
 
 and module_type_path :
     Env.t -> Paths.Path.ModuleType.t -> Paths.Path.ModuleType.t =
@@ -74,11 +74,6 @@ and class_type_path : Env.t -> Paths.Path.ClassType.t -> Paths.Path.ClassType.t
       | Ok p' -> `Resolved Lang_of.(Path.resolved_class_type (empty ()) p')
       | Error _ -> p)
 
-let () =
-  (* Until those are used *)
-  ignore value_path;
-  ignore constructor_path
-
 let rec unit env t =
   let open Compilation_unit in
   let source_info =