Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

odoc: Put support files in their own directory #6913

Merged
merged 6 commits into from
Feb 8, 2023
Merged

odoc: Put support files in their own directory #6913

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
4e7d1fa
odoc: Put support files in their own directory
jonludlam Jan 21, 2023
370d8fc
Set directory targets for the _odoc_support dir
jonludlam Feb 6, 2023
2adb08e
More directory rules fixes for odoc
jonludlam Feb 6, 2023
239d21d
Formatting
jonludlam Feb 6, 2023
e6616e8
Factor out constant
jonludlam Feb 6, 2023
8098bd1
Update CHANGES
jonludlam Feb 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
Unreleased
----------
- Fix handling of support files generated by odoc. (#6913, @jonludlam)

- Fix parsing of OCaml errors that contain code excerpts with `...` in them.
(#7008, @rgrinberg)
Expand Down
49 changes: 31 additions & 18 deletions src/dune_rules/odoc.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,8 @@ let add_rule sctx =
Super_context.add_rule sctx ~dir

module Paths = struct
let odoc_support_dirname = "_odoc_support"

let root (context : Context.t) =
Path.Build.relative context.Context.build_dir "_doc"

Expand All @@ -111,9 +113,7 @@ module Paths = struct

let gen_mld_dir ctx pkg = root ctx ++ "_mlds" ++ Package.Name.to_string pkg

let css_file ctx = html_root ctx ++ "odoc.css"

let highlight_pack_js ctx = html_root ctx ++ "highlight.pack.js"
let odoc_support ctx = html_root ctx ++ odoc_support_dirname

let toplevel_index ctx = html_root ctx ++ "index.html"
end
Expand Down Expand Up @@ -347,12 +347,21 @@ let setup_html sctx (odoc_file : odoc_artefact) =
(odoc_file.html_dir, [ dummy ])
in
let open Memo.O in
let odoc_support_path = Paths.odoc_support ctx in
let html_output = Paths.html_root ctx in
let support_relative =
Path.reach (Path.build odoc_support_path) ~from:(Path.build html_output)
in
let* run_odoc =
run_odoc sctx
~dir:(Path.build (Paths.html_root ctx))
"html-generate" ~flags_for:None
[ A "-o"
; Path (Path.build (Paths.html_root ctx))
; A "--support-uri"
; A support_relative
; A "--theme-uri"
; A support_relative
; Dep (Path.build odoc_file.odocl_file)
; Hidden_targets [ odoc_file.html_file ]
]
Expand All @@ -371,13 +380,15 @@ let setup_html sctx (odoc_file : odoc_artefact) =
let setup_css_rule sctx =
let open Memo.O in
let ctx = Super_context.context sctx in
let dir = Paths.odoc_support ctx in
let* run_odoc =
run_odoc sctx ~dir:(Path.build ctx.build_dir) "support-files"
~flags_for:None
[ A "-o"
; Path (Path.build (Paths.html_root ctx))
; Hidden_targets [ Paths.css_file ctx; Paths.highlight_pack_js ctx ]
]
let+ cmd =
run_odoc sctx ~dir:(Path.build ctx.build_dir) "support-files"
~flags_for:None
[ A "-o"; Path (Path.build dir) ]
in
cmd
|> Action_builder.With_targets.add_directories ~directory_targets:[ dir ]
in
add_rule sctx run_odoc

Expand All @@ -404,7 +415,7 @@ let setup_toplevel_index_rule sctx =
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>index</title>
<link rel="stylesheet" href="./odoc.css"/>
<link rel="stylesheet" href="./%s/odoc.css"/>
emillon marked this conversation as resolved.
Show resolved Hide resolved
<meta charset="utf-8"/>
<meta name="viewport" content="width=device-width,initial-scale=1.0"/>
</head>
Expand All @@ -419,7 +430,7 @@ let setup_toplevel_index_rule sctx =
</main>
</body>
</html>|}
list_items
Paths.odoc_support_dirname list_items
in
let ctx = Super_context.context sctx in
add_rule sctx (Action_builder.write_file (Paths.toplevel_index ctx) html)
Expand Down Expand Up @@ -495,7 +506,7 @@ let create_odoc ctx ~target odoc_file =

let static_html ctx =
let open Paths in
[ css_file ctx; highlight_pack_js ctx; toplevel_index ctx ]
[ odoc_support ctx; toplevel_index ctx ]

let check_mlds_no_dupes ~pkg ~mlds =
match
Expand Down Expand Up @@ -786,14 +797,11 @@ let setup_private_library_doc_alias sctx ~scope ~dir (l : Dune_file.Library.t) =
Rules.Produce.Alias.add_deps (Alias.private_doc ~dir)
(lib |> Dep.html_alias ctx |> Dune_engine.Dep.alias |> Action_builder.dep)

let has_rules m =
let has_rules ?(directory_targets = Path.Build.Map.empty) m =
let rules = Rules.collect_unit (fun () -> m) in
Memo.return
(Build_config.Rules
{ rules
; build_dir_only_sub_dirs = Subdir_set.empty
; directory_targets = Path.Build.Map.empty
})
{ rules; build_dir_only_sub_dirs = Subdir_set.empty; directory_targets })

let with_package pkg ~f =
let pkg = Package.Name.of_string pkg in
Expand All @@ -818,7 +826,12 @@ let gen_rules sctx ~dir:_ rest =
; directory_targets = Path.Build.Map.empty
})
| [ "_html" ] ->
has_rules (setup_css_rule sctx >>> setup_toplevel_index_rule sctx)
let ctx = Super_context.context sctx in
let directory_targets =
Path.Build.Map.singleton (Paths.odoc_support ctx) Loc.none
in
has_rules ~directory_targets
(setup_css_rule sctx >>> setup_toplevel_index_rule sctx)
| [ "_mlds"; pkg ] ->
with_package pkg ~f:(fun pkg ->
let* _mlds, rules = package_mlds sctx ~pkg in
Expand Down
2 changes: 1 addition & 1 deletion test/blackbox-tests/test-cases/odoc/multiple-private-libs.t/run.t
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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/highlight.pack.js,_doc/_html/odoc.css
odoc _doc/_html/_odoc_support
ocamlc a/.test.objs/byte/test.{cmi,cmo,cmt}
ocamlc b/.test.objs/byte/test.{cmi,cmo,cmt}
odoc a/.test.objs/byte/test.odoc
Expand Down
2 changes: 1 addition & 1 deletion test/blackbox-tests/test-cases/odoc/odoc-simple.t/run.t
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ This test if `.odocl` files are generated
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>index</title>
<link rel="stylesheet" href="./odoc.css"/>
<link rel="stylesheet" href="./_odoc_support/odoc.css"/>
<meta charset="utf-8"/>
<meta name="viewport" content="width=device-width,initial-scale=1.0"/>
</head>
Expand Down
2 changes: 1 addition & 1 deletion test/blackbox-tests/test-cases/odoc/odoc-unique-mlds/diff-scope.t/run.t
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Duplicate mld's in different scope
$ dune build @doc --display short
odoc _doc/_html/highlight.pack.js,_doc/_html/odoc.css
odoc _doc/_html/_odoc_support
odoc _doc/_odoc/pkg/scope1/page-index.odoc
ocamlc scope1/.scope1.objs/byte/scope1.{cmi,cmo,cmt}
odoc _doc/_odoc/pkg/scope2/page-index.odoc
Expand Down
2 changes: 1 addition & 1 deletion test/blackbox-tests/test-cases/odoc/odoc-unique-mlds/same-scope.t/run.t
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Duplicate mld's in the same scope
$ dune build @doc --display short
odoc _doc/_html/highlight.pack.js,_doc/_html/odoc.css
odoc _doc/_html/_odoc_support
odoc _doc/_odoc/pkg/root/page-index.odoc
ocamlc lib1/.root_lib1.objs/byte/root_lib1.{cmi,cmo,cmt}
ocamlc lib2/.root_lib2.objs/byte/root_lib2.{cmi,cmo,cmt}
Expand Down