Skip to content

Commit 9b96b35

Browse files
davesnxjonludlam
authored andcommitted
Simplify markdown-multi
1 parent 1abe898 commit 9b96b35

File tree

10 files changed

+28
-261
lines changed

10 files changed

+28
-261
lines changed
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
(** Module A *)
2+
3+
val x : int
4+
(** A value *)
5+

test/integration/markdown-multi.t/array.mli

Lines changed: 0 additions & 39 deletions
This file was deleted.
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
(** Module B *)
2+
3+
val y : string
4+
(** B value *)
5+
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
(** Module C *)
2+
3+
val z : bool
4+
(** C value *)
5+

test/integration/markdown-multi.t/list.mli

Lines changed: 0 additions & 39 deletions
This file was deleted.
-5.47 KB
Binary file not shown.

test/integration/markdown-multi.t/page.mld

Lines changed: 0 additions & 126 deletions
This file was deleted.
Lines changed: 13 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,22 @@
11
Test markdown-generate with multiple .odocl files in a single invocation:
22

3-
$ ocamlc -c -bin-annot test.mli
4-
$ ocamlc -c -bin-annot test2.mli
5-
$ ocamlc -c -bin-annot list.mli
6-
$ odoc compile --package test -I . page.mld
7-
File "page.mld", line 25, characters 23-34:
8-
Warning: '{{!...} ...}' (cross-reference) should not be empty.
9-
File "page.mld", line 35, characters 23-32:
10-
Warning: '{{!...} ...}' (cross-reference) should not be empty.
11-
File "page.mld", line 35, characters 49-59:
12-
Warning: '{{!...} ...}' (cross-reference) should not be empty.
13-
File "page.mld", line 125, characters 0-11:
14-
Warning: Tags are not allowed in pages.
15-
$ odoc compile --package test test.cmti
16-
$ odoc compile --package test -I . test2.cmti
17-
$ odoc compile --package list -I . list.cmti
18-
File "list.mli", line 1, characters 4-12:
19-
Warning: '{0': heading level should be lower than top heading level '0'.
20-
$ odoc link test.odoc
21-
$ odoc link test2.odoc
22-
$ odoc link list.odoc
23-
File "list.mli", line 37, characters 12-19:
24-
Warning: Reference to 'head' is ambiguous. Please specify its kind: section-head, val-head.
25-
$ odoc link page-page.odoc
26-
File "page.mld", line 85, characters 0-33:
27-
Warning: Failed to resolve reference ./odoc_logo_placeholder.jpg Path 'odoc_logo_placeholder.jpg' not found
28-
File "page.mld", line 29, characters 4-49:
29-
Warning: Failed to resolve reference ./test.mli Path 'test' not found
3+
$ ocamlc -c -bin-annot a.mli
4+
$ ocamlc -c -bin-annot b.mli
5+
$ ocamlc -c -bin-annot c.mli
6+
$ odoc compile --package test a.cmti
7+
$ odoc compile --package test b.cmti
8+
$ odoc compile --package test c.cmti
9+
$ odoc link a.odoc
10+
$ odoc link b.odoc
11+
$ odoc link c.odoc
3012

3113
Generate with separate invocations:
32-
$ odoc markdown-generate test.odocl -o markdown-separate
33-
$ odoc markdown-generate test2.odocl -o markdown-separate
34-
$ odoc markdown-generate page-page.odocl -o markdown-separate
35-
$ odoc markdown-generate list.odocl -o markdown-separate
14+
$ odoc markdown-generate a.odocl -o markdown-separate
15+
$ odoc markdown-generate b.odocl -o markdown-separate
16+
$ odoc markdown-generate c.odocl -o markdown-separate
3617

3718
Generate with multiple files in one invocation:
38-
$ odoc markdown-generate test.odocl test2.odocl page-page.odocl list.odocl -o markdown-multi
19+
$ odoc markdown-generate a.odocl b.odocl c.odocl -o markdown-multi
3920

4021
Verify both approaches produce identical output:
4122
$ diff -r markdown-separate markdown-multi
42-

test/integration/markdown-multi.t/test.mli

Lines changed: 0 additions & 23 deletions
This file was deleted.

test/integration/markdown-multi.t/test2.mli

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)