Expect odoc to generate highlight.pack.js (#1557)

See #1556. Signed-off-by: Anton Bachin <antonbachin@yahoo.com>
ocaml · Nov 20, 2018 · f3caaaa · f3caaaa
1 parent 19893f7
commit f3caaaa
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 7 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -25,6 +25,9 @@ next
 
 - Add a `--stats` command line option to record resource usage (#1543, @diml)
 
+- Fix `dune build @doc` deleting `highlight.pack.js` on rebuilds, after the
+  first build (#1557, @aantron).
+
 1.5.1 (7/11/2018)
 -----------------
 

diff --git a/dune.opam b/dune.opam
@@ -17,6 +17,7 @@ build: [
 ]
 conflicts: [
   "jbuilder" {!= "transition"}
+  "odoc" {< "1.3.0"}
 ]
 
 synopsis: "Fast, portable and opinionated build system"

diff --git a/src/odoc.ml b/src/odoc.ml
@@ -193,6 +193,7 @@ module Gen (S : sig val sctx : SC.t end) = struct
          :: dune_keep))
 
   let css_file = Paths.html_root ++ "odoc.css"
+  let highlight_pack_js = Paths.html_root ++ "highlight.pack.js"
 
   let toplevel_index = Paths.html_root ++ "index.html"
 
@@ -220,8 +221,8 @@ module Gen (S : sig val sctx : SC.t end) = struct
       (Build.run
          ~dir:context.build_dir
          (Lazy.force odoc)
-         [ A "css"; A "-o"; Path Paths.html_root
-         ; Hidden_targets [css_file]
+         [ A "support-files"; A "-o"; Path Paths.html_root
+         ; Hidden_targets [css_file; highlight_pack_js]
          ])
 
   let sp = Printf.sprintf
@@ -305,7 +306,7 @@ module Gen (S : sig val sctx : SC.t end) = struct
       ; source = Mld
       }
 
-  let static_html = [ css_file; toplevel_index ]
+  let static_html = [ css_file; highlight_pack_js; toplevel_index ]
 
   let odocs =
     let odoc_glob =

diff --git a/test/blackbox-tests/test-cases/multiple-private-libs/run.t b/test/blackbox-tests/test-cases/multiple-private-libs/run.t
@@ -1,7 +1,7 @@
 This test checks that there is no clash when two private libraries have the same name
 
   $ dune build --display short @doc-private
-          odoc _doc/_html/odoc.css
+          odoc _doc/_html/highlight.pack.js,_doc/_html/odoc.css
       ocamldep a/.test.objs/test.ml.d
         ocamlc a/.test.objs/test.{cmi,cmo,cmt}
           odoc _doc/_odoc/lib/test@a/test.odoc

diff --git a/test/blackbox-tests/test-cases/odoc-unique-mlds/run.t b/test/blackbox-tests/test-cases/odoc-unique-mlds/run.t
@@ -1,7 +1,7 @@
 Duplicate mld's in the same scope
   $ dune build @doc --display short --root ./same-scope
   Entering directory 'same-scope'
-          odoc _doc/_html/odoc.css
+          odoc _doc/_html/highlight.pack.js,_doc/_html/odoc.css
         ocamlc lib1/.root_lib1.objs/root_lib1.{cmi,cmo,cmt}
           odoc _doc/_odoc/lib/root.lib1/root_lib1.odoc
         ocamlc lib2/.root_lib2.objs/root_lib2.{cmi,cmo,cmt}
@@ -15,7 +15,7 @@ Duplicate mld's in different scope
   $ rm -rf diff-scope/_build
   $ dune build @doc --display short --root ./diff-scope
   Entering directory 'diff-scope'
-          odoc _doc/_html/odoc.css
+          odoc _doc/_html/highlight.pack.js,_doc/_html/odoc.css
         ocamlc scope1/.scope1.objs/scope1.{cmi,cmo,cmt}
           odoc _doc/_odoc/lib/scope1/scope1.odoc
           odoc _doc/_html/scope1/Scope1/.dune-keep,_doc/_html/scope1/Scope1/index.html

diff --git a/test/blackbox-tests/test-cases/odoc/run.t b/test/blackbox-tests/test-cases/odoc/run.t
@@ -5,7 +5,7 @@
           odoc _doc/_html/bar/Bar/.dune-keep,_doc/_html/bar/Bar/index.html
           odoc _doc/_odoc/pkg/bar/page-index.odoc
           odoc _doc/_html/bar/index.html
-          odoc _doc/_html/odoc.css
+          odoc _doc/_html/highlight.pack.js,_doc/_html/odoc.css
       ocamldep .foo_byte.objs/foo_byte.ml.d
         ocamlc .foo_byte.objs/foo_byte.{cmi,cmo,cmt}
           odoc _doc/_odoc/lib/foo.byte/foo_byte.odoc