Merge pull request #2009 from rgrinberg/list-public-modules

List only public modules in generated index
ocaml · Apr 3, 2019 · 73cf910 · 73cf910
2 parents bed7677 + b3ec401
commit 73cf910
Show file tree

Hide file tree

Showing 6 changed files with 11 additions and 3 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/dune b/test/blackbox-tests/test-cases/odoc/dune
@@ -1,7 +1,8 @@
 (library
  (name foo)
- (modules foo foo2)
+ (modules foo foo2 foo3)
  (wrapped false)
+ (private_modules foo3)
  (public_name foo))
 
 (library

diff --git a/test/blackbox-tests/test-cases/odoc/dune-project b/test/blackbox-tests/test-cases/odoc/dune-project
@@ -1 +1 @@
-(lang dune 1.0)
+(lang dune 1.2)
diff --git a/test/blackbox-tests/test-cases/odoc/foo3.ml b/test/blackbox-tests/test-cases/odoc/foo3.ml
diff --git a/test/blackbox-tests/test-cases/odoc/run.t b/test/blackbox-tests/test-cases/odoc/run.t
@@ -12,6 +12,9 @@
       ocamldep .foo.objs/foo2.ml.d
         ocamlc .foo.objs/byte/foo2.{cmi,cmo,cmt}
           odoc _doc/_odoc/lib/foo/foo2.odoc
+      ocamldep .foo.objs/foo3.ml.d
+        ocamlc .foo.objs/byte/foo3.{cmi,cmo,cmt}
+          odoc _doc/_odoc/lib/foo/private/foo3.odoc
       ocamldep .foo_byte.objs/foo_byte.ml.d
         ocamlc .foo_byte.objs/byte/foo_byte.{cmi,cmo,cmt}
           odoc _doc/_odoc/lib/foo.byte/foo_byte.odoc