List only public modules in generated index

Fix #2008 Signed-off-by: Rudi Grinberg <[email protected]>
ocaml · Apr 2, 2019 · b3ec401 · b3ec401
1 parent 8430794
commit b3ec401
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 2 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -21,10 +21,13 @@ unreleased
 
 - Install .cmi files of private modules in a `.private` directory (#1983, fix
   #1973 @rgrinberg)
-  
+
 - Fix dune subst attempting to sunbstitute on directories. (#2000, fix #1997,
   @rgrinberg)
 
+- Do not list private modules in the generated index. (#2009, fix #2008,
+  @rgrinberg)
+
 1.8.2 (10/03/2019)
 ------------------
 

diff --git a/src/odoc.ml b/src/odoc.ml
@@ -473,6 +473,7 @@ let default_index ~pkg entry_modules =
           "This library exposes the following toplevel modules:\n\
            {!modules:%s}\n"
           (modules
+           |> List.filter ~f:Module.is_public
            |> List.sort ~compare:(fun x y ->
              Module.Name.compare (Module.name x) (Module.name y))
            |> List.map ~f:(fun m -> Module.Name.to_string (Module.name m))

diff --git a/test/blackbox-tests/test-cases/odoc/run.t b/test/blackbox-tests/test-cases/odoc/run.t
@@ -49,7 +49,7 @@
   {0 foo index}
   {1 Library foo}
   This library exposes the following toplevel modules:
-  {!modules:Foo Foo2 Foo3}
+  {!modules:Foo Foo2}
   {1 Library foo.byte}
   The entry point of this library is the module:
   {!module-Foo_byte}.