Merge pull request #731 from rgrinberg/gh717

Fix 717

CHANGES.md

@@ -21,6 +21,8 @@ next
 - `-j` now defaults to the number of processing units available rather
   4 (#726, @diml)
 
+- Fix attaching index.mld to documentation (#731, fixes #717 @rgrinberg)
+
 1.0+beta20 (10/04/2018)
 -----------------------
 

src/odoc.ml

@@ -433,7 +433,8 @@ module Gen (S : sig val sctx : SC.t end) = struct
 
   let check_mlds_no_dupes ~pkg ~mlds =
     match
-      List.map mlds ~f:(fun mld -> (Path.basename mld, mld))
+      List.map mlds ~f:(fun mld ->
+        (Filename.chop_extension (Path.basename mld), mld))
       |> String.Map.of_list
     with
     | Ok m -> m

test/blackbox-tests/gen_tests.ml

@@ -89,12 +89,14 @@ end
 
 let exclusions =
   let open Test in
+  let odoc = make ~external_deps:true ~skip_ocaml:"4.02.3" in
   [ make "js_of_ocaml" ~external_deps:true ~js:true ~env:("NODE", "${bin:node}")
   ; make "github25" ~env:("OCAMLPATH", "./findlib-packages")
-  ; make "odoc" ~external_deps:true ~skip_ocaml:"4.02.3"
-  ; make "multiple-private-libs" ~external_deps:true ~skip_ocaml:"4.02.3"
+  ; odoc "odoc"
+  ; odoc "odoc-unique-mlds"
+  ; odoc "github717-odoc-index"
+  ; odoc "multiple-private-libs"
   ; make "ppx-rewriter" ~skip_ocaml:"4.02.3" ~external_deps:true
-  ; make "odoc-unique-mlds" ~skip_ocaml:"4.02.3" ~external_deps:true
   ; make "output-obj" ~skip_platforms:[Mac; Win] ~skip_ocaml:"<4.06.0"
   ; make "github644" ~external_deps:true
   ; make "private-public-overlap" ~external_deps:true

test/blackbox-tests/jbuild.inc

@@ -170,6 +170,17 @@
     test-cases/github660
     (progn (run ${exe:cram.exe} -test run.t) (diff? run.t run.t.corrected))))))
 
+(alias
+ ((name github717-odoc-index)
+  (deps
+   ((package jbuilder) (files_recursively_in test-cases/github717-odoc-index)))
+  (action
+   (chdir
+    test-cases/github717-odoc-index
+    (progn
+     (run ${exe:cram.exe} -skip-versions 4.02.3 -test run.t)
+     (diff? run.t run.t.corrected))))))
+
 (alias
  ((name include-loop)
   (deps ((package jbuilder) (files_recursively_in test-cases/include-loop)))
@@ -454,6 +465,7 @@
     (alias github597)
     (alias github644)
     (alias github660)
+    (alias github717-odoc-index)
     (alias include-loop)
     (alias inline_tests)
     (alias installable-dup-private-libs)

test/blackbox-tests/test-cases/github717-odoc-index/index.mld

@@ -0,0 +1 @@
+Test index.

test/blackbox-tests/test-cases/github717-odoc-index/jbuild

@@ -0,0 +1,8 @@
+(jbuild_version 1)
+
+(library
+ ((name hello_world)
+  (public_name hello_world)
+  (libraries ())))
+
+(documentation ())

test/blackbox-tests/test-cases/github717-odoc-index/run.t

@@ -0,0 +1 @@
+  $ jbuilder build @doc