add test to demostrate that dune doesn't generate docs for hidden mod…

…ules Signed-off-by: lubegasimon <[email protected]>
ocaml · Apr 28, 2021 · 56981b4 · 56981b4
1 parent 022380a
commit 56981b4
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 0 deletions.
diff --git a/test/blackbox-tests/test-cases/odoc/odoc-wrapped-lib.t/bar.ml b/test/blackbox-tests/test-cases/odoc/odoc-wrapped-lib.t/bar.ml
diff --git a/test/blackbox-tests/test-cases/odoc/odoc-wrapped-lib.t/dune b/test/blackbox-tests/test-cases/odoc/odoc-wrapped-lib.t/dune
@@ -0,0 +1,2 @@
+(library
+ (public_name foo))
diff --git a/test/blackbox-tests/test-cases/odoc/odoc-wrapped-lib.t/dune-project b/test/blackbox-tests/test-cases/odoc/odoc-wrapped-lib.t/dune-project
@@ -0,0 +1 @@
+(lang dune 1.10)
diff --git a/test/blackbox-tests/test-cases/odoc/odoc-wrapped-lib.t/foo.opam b/test/blackbox-tests/test-cases/odoc/odoc-wrapped-lib.t/foo.opam
diff --git a/test/blackbox-tests/test-cases/odoc/odoc-wrapped-lib.t/run.t b/test/blackbox-tests/test-cases/odoc/odoc-wrapped-lib.t/run.t
@@ -0,0 +1,20 @@
+This test generates documentation for non-hidden modules only using odoc for a library:
+
+  $ dune build @doc
+  $ ls -R _build/default/_doc/_html
+  foo
+  highlight.pack.js
+  index.html
+  odoc.css
+
+  _build/default/_doc/_html/foo:
+  Foo
+  index.html
+
+  _build/default/_doc/_html/foo/Foo:
+  Bar
+  index.html
+
+  _build/default/_doc/_html/foo/Foo/Bar:
+  index.html
+