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

odoc: put odoc support files in odoc.support #7588

Merged
merged 2 commits into from
May 3, 2023
Merged

odoc: put odoc support files in odoc.support #7588

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7995560
odoc: put odoc support files in odoc.support
emillon Apr 20, 2023
7acb138
Merge branch 'main' into dot-odoc-support
emillon May 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,10 @@ Unreleased
This is consistent with how `(executables)` handles this field.
(#7576 , fixes #5852, @emillon)

- Change directory of odoc assets to `odoc.support` (was `_odoc_support`) so
that it works with Github Pages out of the box. (#7588, fixes #7364,
@emillon)

3.7.0 (2023-02-17)
------------------

Expand Down
2 changes: 1 addition & 1 deletion src/dune_rules/odoc.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ let add_rule sctx =
Super_context.add_rule sctx ~dir

module Paths = struct
let odoc_support_dirname = "_odoc_support"
let odoc_support_dirname = "odoc.support"

let root (context : Context.t) =
Path.Build.relative context.Context.build_dir "_doc"
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/_odoc_support
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_support/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/_odoc_support
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/_odoc_support
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