Skip to content

Commit b04e914

Browse files
jonludlamjonludlam
committed
[new release] odoc (5 packages) (3.1.0)
CHANGES: - Exposed sherlodoc libraries for use in other projects (@jonludlam, ocaml/odoc#1349) - OCaml 5.4.0 support (@Octachron, ocaml/odoc#1355) - New arguments to LaTeX generator, --shorten-beyond-depth and --remove-functor-arg-link (@Octachron, ocaml/odoc#1337) - New experimental markdown generator (@davesnx, ocaml/odoc#1341) - Remove cmdliner compatibility layer, no longer needed (@dbuenzli, ocaml/odoc#1328) - Drop support for OCaml < 4.08 (@jonludlam, ocaml/odoc#1300) - Allow referencing libraries from package added in `odoc-config.sexp` (@panglesd, ocaml/odoc#1343) - Use full path in heading labels in LaTeX backend (@Octachron, ocaml/odoc#1332) - Separate page from anchor in LaTeX labels to prevent collisions (@Octachron, ocaml/odoc#1337) - Fix bug in parsing META files when there are no dependencies (@jonludlam, ocaml/odoc#1352) - Fix ocaml/odoc#1335 - incorrect rendering when on medium screen size with no global sidebar (@lukemaurer, ocaml/odoc#1361) - Fixed generation of occurrences for docs CI (@jonludlam, ocaml/odoc#1362) - Partial fix for ocaml/odoc#1369 - ensure that we never create a link to a hidden page (@jonludlam, ocaml/odoc#1370)
1 parent fb593fd commit b04e914

File tree

5 files changed

+321
-0
lines changed
  • packages
    • odoc-driver/odoc-driver.3.1.0
    • odoc-md/odoc-md.3.1.0
    • odoc-parser/odoc-parser.3.1.0
    • odoc/odoc.3.1.0
    • sherlodoc/sherlodoc.3.1.0

5 files changed

+321
-0
lines changed

‎packages/odoc-driver/odoc-driver.3.1.0/opam

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
opam-version: "2.0"
2+
homepage: "https://github.com/ocaml/odoc"
3+
doc: "https://ocaml.github.io/odoc/"
4+
bug-reports: "https://github.com/ocaml/odoc/issues"
5+
license: "ISC"
6+
7+
maintainer: [
8+
"Daniel Bünzli <[email protected]>"
9+
"Jon Ludlam <[email protected]>"
10+
"Jules Aguillon <[email protected]>"
11+
"Paul-Elliot Anglès d'Auriac <[email protected]>"
12+
]
13+
authors: [
14+
"Anton Bachin <[email protected]>"
15+
"Daniel Bünzli <[email protected]>"
16+
"David Sheets <[email protected]>"
17+
"Jon Ludlam <[email protected]>"
18+
"Jules Aguillon <[email protected]>"
19+
"Leo White <[email protected]>"
20+
"Lubega Simon <[email protected]>"
21+
"Paul-Elliot Anglès d'Auriac <[email protected]>"
22+
"Thomas Refis <[email protected]>"
23+
]
24+
dev-repo: "git+https://github.com/ocaml/odoc.git"
25+
26+
synopsis: "OCaml Documentation Generator - Driver"
27+
description: """
28+
The driver is a sample implementation of a tool to drive odoc to generate
29+
documentation for installed packages.
30+
"""
31+
32+
33+
depends: [
34+
"ocaml" {>= "5.1.0"}
35+
"odoc" {= version}
36+
"dune" {>= "3.18.0"}
37+
"odoc-md"
38+
"bos"
39+
"fpath" {>= "0.7.3"}
40+
"yojson" {>= "2.0.0"}
41+
"ocamlfind"
42+
"opam-format" {>= "2.1.0"}
43+
"logs"
44+
"eio_main"
45+
"eio" {>= "1.0"}
46+
"progress"
47+
"cmdliner" {>= "1.3.0"}
48+
"sexplib"
49+
"ppx_sexp_conv"
50+
"sherlodoc"
51+
]
52+
53+
build: [
54+
["dune" "subst"] {dev}
55+
[
56+
"dune"
57+
"build"
58+
"-p"
59+
name
60+
"-j"
61+
jobs
62+
"@install"
63+
"@doc" {with-doc}
64+
]
65+
]
66+
67+
x-maintenance-intent: ["(latest)"]
68+
url {
69+
src: "https://github.com/ocaml/odoc/releases/download/3.1.0/odoc-3.1.0.tbz"
70+
checksum: [
71+
"sha256=355b3cfff4934903cbaed8b51ce35e333e8609932d230294200a9f2d42ffa914"
72+
"sha512=f78318d0a16164a9cd16ee02f611c2e00d32b772fe38e992d6db6ec94b1c00cd9c377fbfe64031b8f245e57b2f3aac9364108327e7f1693533ddcff94c476e05"
73+
]
74+
}
75+
x-commit-hash: "dbe1333c687102e1a9a1cbe59d63b8f69e6b1af0"

‎packages/odoc-md/odoc-md.3.1.0/opam

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
opam-version: "2.0"
2+
homepage: "https://github.com/ocaml/odoc"
3+
doc: "https://ocaml.github.io/odoc/"
4+
bug-reports: "https://github.com/ocaml/odoc/issues"
5+
license: "ISC"
6+
7+
maintainer: [
8+
"Jon Ludlam <[email protected]>"
9+
"Jules Aguillon <[email protected]>"
10+
"Paul-Elliot Anglès d'Auriac <[email protected]>"
11+
]
12+
authors: [
13+
"Daniel Bünzli <[email protected]>"
14+
"Paul-Elliot Anglès d'Auriac <[email protected]>"
15+
"Jon Ludlam <[email protected]>"
16+
]
17+
dev-repo: "git+https://github.com/ocaml/odoc.git"
18+
19+
synopsis: "OCaml Documentation Generator - Markdown support"
20+
description: """
21+
Odoc-md is part of the odoc suite of tools for generating documentation for OCaml packages.
22+
23+
This package provides support for generating documentation from Markdown files.
24+
"""
25+
26+
depends: [
27+
"ocaml" {>= "4.14.0"}
28+
"odoc" {= version}
29+
"dune" {>= "3.18.0"}
30+
"cmdliner" {>= "1.3.0"}
31+
"cmarkit"
32+
]
33+
34+
build: [
35+
["dune" "subst"] {dev}
36+
[
37+
"dune"
38+
"build"
39+
"-p"
40+
name
41+
"-j"
42+
jobs
43+
"@install"
44+
"@doc" {with-doc}
45+
]
46+
]
47+
48+
x-maintenance-intent: ["(latest)"]
49+
url {
50+
src: "https://github.com/ocaml/odoc/releases/download/3.1.0/odoc-3.1.0.tbz"
51+
checksum: [
52+
"sha256=355b3cfff4934903cbaed8b51ce35e333e8609932d230294200a9f2d42ffa914"
53+
"sha512=f78318d0a16164a9cd16ee02f611c2e00d32b772fe38e992d6db6ec94b1c00cd9c377fbfe64031b8f245e57b2f3aac9364108327e7f1693533ddcff94c476e05"
54+
]
55+
}
56+
x-commit-hash: "dbe1333c687102e1a9a1cbe59d63b8f69e6b1af0"
57+

‎packages/odoc-parser/odoc-parser.3.1.0/opam

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
opam-version: "2.0"
2+
synopsis: "Parser for ocaml documentation comments"
3+
description: """
4+
Odoc_parser is a library for parsing the contents of OCaml documentation
5+
comments, formatted using 'odoc' syntax, an extension of the language
6+
understood by ocamldoc."""
7+
maintainer: ["Jon Ludlam <[email protected]>"]
8+
authors: ["Anton Bachin <[email protected]>"]
9+
license: "ISC"
10+
homepage: "https://github.com/ocaml/odoc"
11+
bug-reports: "https://github.com/ocaml/odoc/issues"
12+
dev-repo: "git+https://github.com/ocaml/odoc.git"
13+
doc: "https://ocaml.github.io/odoc/odoc_parser"
14+
depends: [
15+
"dune" {>= "3.18"}
16+
"ocaml" {>= "4.08.0" & < "5.5"}
17+
"astring"
18+
"camlp-streams"
19+
"ppx_expect" {with-test}
20+
"sexplib0" {with-test}
21+
]
22+
build: [
23+
["dune" "subst"] {dev}
24+
[
25+
"dune"
26+
"build"
27+
"-p"
28+
name
29+
"-j"
30+
jobs
31+
"@install"
32+
# Tests are not all associated with a package and would be run if using the
33+
# default '@runtest'.
34+
"@src/parser/runtest" {with-test}
35+
]
36+
]
37+
x-maintenance-intent: ["(latest)"]
38+
url {
39+
src: "https://github.com/ocaml/odoc/releases/download/3.1.0/odoc-3.1.0.tbz"
40+
checksum: [
41+
"sha256=355b3cfff4934903cbaed8b51ce35e333e8609932d230294200a9f2d42ffa914"
42+
"sha512=f78318d0a16164a9cd16ee02f611c2e00d32b772fe38e992d6db6ec94b1c00cd9c377fbfe64031b8f245e57b2f3aac9364108327e7f1693533ddcff94c476e05"
43+
]
44+
}
45+
x-commit-hash: "dbe1333c687102e1a9a1cbe59d63b8f69e6b1af0"
46+

‎packages/odoc/odoc.3.1.0/opam

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
opam-version: "2.0"
2+
homepage: "https://github.com/ocaml/odoc"
3+
doc: "https://ocaml.github.io/odoc/"
4+
bug-reports: "https://github.com/ocaml/odoc/issues"
5+
license: "ISC"
6+
7+
maintainer: [
8+
"Daniel Bünzli <[email protected]>"
9+
"Jon Ludlam <[email protected]>"
10+
"Jules Aguillon <[email protected]>"
11+
"Paul-Elliot Anglès d'Auriac <[email protected]>"
12+
]
13+
authors: [
14+
"Anton Bachin <[email protected]>"
15+
"Daniel Bünzli <[email protected]>"
16+
"David Sheets <[email protected]>"
17+
"Jon Ludlam <[email protected]>"
18+
"Jules Aguillon <[email protected]>"
19+
"Leo White <[email protected]>"
20+
"Lubega Simon <[email protected]>"
21+
"Paul-Elliot Anglès d'Auriac <[email protected]>"
22+
"Thomas Refis <[email protected]>"
23+
]
24+
dev-repo: "git+https://github.com/ocaml/odoc.git"
25+
26+
synopsis: "OCaml Documentation Generator"
27+
description: """
28+
**odoc** is a powerful and flexible documentation generator for OCaml. It reads *doc comments*, demarcated by `(** ... *)`, and transforms them into a variety of output formats, including HTML, LaTeX, and man pages.
29+
30+
- **Output Formats:** Odoc generates HTML for web browsing, LaTeX for PDF generation, and man pages for use on Unix-like systems.
31+
- **Cross-References:** odoc uses the `ocamldoc` markup, which allows to create links for functions, types, modules, and documentation pages.
32+
- **Link to Source Code:** Documentation generated includes links to the source code of functions, providing an easy way to navigate from the docs to the actual implementation.
33+
- **Code Highlighting:** odoc automatically highlights syntax in code snippets for different languages.
34+
35+
odoc is part of the [OCaml Platform](https://ocaml.org/docs/platform), the recommended set of tools for OCaml.
36+
"""
37+
38+
39+
depends: [
40+
"odoc-parser" {= version}
41+
"astring"
42+
"cmdliner" {>= "1.3.0"}
43+
"cppo" {build & >= "1.1.0"}
44+
"dune" {>= "3.18.0"}
45+
"fpath" {>= "0.7.3"}
46+
"ocaml" {>= "4.08.0" & < "5.5"}
47+
"tyxml" {>= "4.4.0"}
48+
"fmt"
49+
"crunch" {>= "1.4.1"}
50+
"ocamlfind" {with-test}
51+
"yojson" {>= "2.1.0" & with-test}
52+
"sexplib0" {with-test}
53+
"conf-jq" {with-test}
54+
"ppx_expect" {with-test}
55+
"bos" {with-test}
56+
"bisect_ppx" {with-test & > "2.5.0"}
57+
]
58+
59+
conflicts: [ "ocaml-option-bytecode-only" ]
60+
61+
x-extra-doc-deps: [
62+
"odoc-driver" {= version}
63+
"sherlodoc" {= version}
64+
"odig"
65+
]
66+
67+
build: [
68+
["dune" "subst"] {dev}
69+
[
70+
"dune"
71+
"build"
72+
"-p"
73+
name
74+
"-j"
75+
jobs
76+
"@install"
77+
"@runtest" {with-test}
78+
"@doc" {with-doc}
79+
]
80+
]
81+
x-maintenance-intent: ["(latest)"]
82+
url {
83+
src: "https://github.com/ocaml/odoc/releases/download/3.1.0/odoc-3.1.0.tbz"
84+
checksum: [
85+
"sha256=355b3cfff4934903cbaed8b51ce35e333e8609932d230294200a9f2d42ffa914"
86+
"sha512=f78318d0a16164a9cd16ee02f611c2e00d32b772fe38e992d6db6ec94b1c00cd9c377fbfe64031b8f245e57b2f3aac9364108327e7f1693533ddcff94c476e05"
87+
]
88+
}
89+
x-commit-hash: "dbe1333c687102e1a9a1cbe59d63b8f69e6b1af0"

‎packages/sherlodoc/sherlodoc.3.1.0/opam

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
opam-version: "2.0"
2+
synopsis: "Search engine for OCaml documentation"
3+
maintainer: ["[email protected]"]
4+
authors: ["Arthur Wendling" "Emile Trotignon"]
5+
license: "MIT"
6+
homepage: "https://github.com/ocaml/odoc"
7+
doc: "https://ocaml.github.io/odoc/"
8+
bug-reports: "https://github.com/ocaml/odoc/issues"
9+
depends: [
10+
"dune" {>= "3.18"}
11+
"ocaml" {>= "4.0.8"}
12+
"odoc" {= version}
13+
"base64" {>= "3.5.1"}
14+
"bigstringaf" {>= "0.9.1"}
15+
"js_of_ocaml" {>= "5.6.0"}
16+
"brr" {>= "0.0.6"}
17+
"cmdliner" {>= "1.3.0"}
18+
"decompress" {>= "1.5.3"}
19+
"fpath" {>= "0.7.3"}
20+
"lwt" {>= "5.7.0"}
21+
"menhir" {>= "20230608"}
22+
"ppx_blob" {>= "0.9.0"}
23+
"tyxml" {>= "4.6.0"}
24+
"result" {>= "1.5"}
25+
"odig" {with-test}
26+
"alcotest" {with-test}
27+
]
28+
depopts: [
29+
"ancient" {>= "0.9.1"}
30+
]
31+
build: [
32+
["dune" "subst"] {dev}
33+
[
34+
"dune"
35+
"build"
36+
"-p"
37+
name
38+
"-j"
39+
jobs
40+
"@install"
41+
"@sherlodoc/runtest" {with-test}
42+
"@doc" {with-doc}
43+
]
44+
]
45+
dev-repo: "git+https://github.com/ocaml/odoc.git"
46+
x-maintenance-intent: ["(latest)"]
47+
url {
48+
src: "https://github.com/ocaml/odoc/releases/download/3.1.0/odoc-3.1.0.tbz"
49+
checksum: [
50+
"sha256=355b3cfff4934903cbaed8b51ce35e333e8609932d230294200a9f2d42ffa914"
51+
"sha512=f78318d0a16164a9cd16ee02f611c2e00d32b772fe38e992d6db6ec94b1c00cd9c377fbfe64031b8f245e57b2f3aac9364108327e7f1693533ddcff94c476e05"
52+
]
53+
}
54+
x-commit-hash: "dbe1333c687102e1a9a1cbe59d63b8f69e6b1af0"

0 commit comments

Comments
 (0)