Skip to content

Commit 12d8668

Browse files
avsmavsm
authored
Merge pull request #27309 from jonludlam/release-odoc-3.0.0_beta1
[new release] odoc (5 packages) (3.0.0~beta1)
2 parents 753a4bd + c142d76 commit 12d8668

File tree

6 files changed

+340
-1
lines changed
  • packages
    • odoc-driver/odoc-driver.3.0.0~beta1
    • odoc-md/odoc-md.3.0.0~beta1
    • odoc-parser/odoc-parser.3.0.0~beta1
    • odoc/odoc.3.0.0~beta1
    • sherlodoc
      • sherlodoc.0.2
      • sherlodoc.3.0.0~beta1

6 files changed

+340
-1
lines changed

‎packages/odoc-driver/odoc-driver.3.0.0~beta1/opam‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
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+
flags: [ avoid-version ]
7+
8+
maintainer: [
9+
"Daniel Bünzli <daniel.buenzli@erratique.ch>"
10+
"Jon Ludlam <jon@recoil.org>"
11+
"Jules Aguillon <juloo.dsi@gmail.com>"
12+
"Paul-Elliot Anglès d'Auriac <paul-elliot@tarides.com>"
13+
]
14+
authors: [
15+
"Anton Bachin <antonbachin@yahoo.com>"
16+
"Daniel Bünzli <daniel.buenzli@erratique.ch>"
17+
"David Sheets <sheets@alum.mit.edu>"
18+
"Jon Ludlam <jon@recoil.org>"
19+
"Jules Aguillon <juloo.dsi@gmail.com>"
20+
"Leo White <leo@lpw25.net>"
21+
"Lubega Simon <lubegasimon73@gmail.com>"
22+
"Paul-Elliot Anglès d'Auriac <paul-elliot@tarides.com>"
23+
"Thomas Refis <trefis@janestreet.com>"
24+
]
25+
dev-repo: "git+https://github.com/ocaml/odoc.git"
26+
27+
synopsis: "OCaml Documentation Generator - Driver"
28+
description: """
29+
The driver is a sample implementation of a tool to drive odoc to generate
30+
documentation for installed packages.
31+
"""
32+
33+
34+
depends: [
35+
"ocaml" {>= "5.1.0"}
36+
"odoc" {= version}
37+
"dune" {>= "3.7.0"}
38+
"odoc-md"
39+
"bos"
40+
"fpath"
41+
"yojson" {>= "2.0.0"}
42+
"ocamlfind"
43+
"opam-format" {>= "2.1.0"}
44+
"logs"
45+
"eio_main"
46+
"eio" {>= "1.0"}
47+
"progress"
48+
"cmdliner" {>= "1.1.0"}
49+
"sexplib"
50+
"ppx_sexp_conv"
51+
"sherlodoc"
52+
]
53+
54+
build: [
55+
["dune" "subst"] {dev}
56+
[
57+
"dune"
58+
"build"
59+
"-p"
60+
name
61+
"-j"
62+
jobs
63+
"@install"
64+
"@doc" {with-doc}
65+
]
66+
]
67+
68+
x-maintenance-intent: ["(latest)"]
69+
url {
70+
src:
71+
"https://github.com/ocaml/odoc/releases/download/3.0.0_beta1/odoc-3.0.0.beta1.tbz"
72+
checksum: [
73+
"sha256=237473ccb54db660c0d476529268df4095a437906612f2ab5f01979852ca01ef"
74+
"sha512=c758448306f867e90203634b5e4e63b83b4c14ab293f5e0623fb2d3a852b4e944998b174a4b0ea758b098eef588aab92882095e28a59ed6b430677c0497fd70b"
75+
]
76+
}
77+
x-commit-hash: "12ad5b5ff2a37d24070553180167d9cdbe631b80"
78+

‎packages/odoc-md/odoc-md.3.0.0~beta1/opam‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
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+
flags: [ avoid-version ]
7+
8+
maintainer: [
9+
"Jon Ludlam <jon@recoil.org>"
10+
"Jules Aguillon <juloo.dsi@gmail.com>"
11+
"Paul-Elliot Anglès d'Auriac <paul-elliot@tarides.com>"
12+
]
13+
authors: [
14+
"Daniel Bünzli <daniel.buenzli@erratique.ch>"
15+
"Paul-Elliot Anglès d'Auriac <paul-elliot@tarides.com>"
16+
"Jon Ludlam <jon@recoil.org>"
17+
]
18+
dev-repo: "git+https://github.com/ocaml/odoc.git"
19+
20+
synopsis: "OCaml Documentation Generator - Markdown support"
21+
description: """
22+
Odoc-md is part of the odoc suite of tools for generating documentation for OCaml packages.
23+
24+
This package provides support for generating documentation from Markdown files.
25+
"""
26+
27+
depends: [
28+
"ocaml" {>= "4.14.0"}
29+
"odoc" {= version}
30+
"dune" {>= "3.7.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:
51+
"https://github.com/ocaml/odoc/releases/download/3.0.0_beta1/odoc-3.0.0.beta1.tbz"
52+
checksum: [
53+
"sha256=237473ccb54db660c0d476529268df4095a437906612f2ab5f01979852ca01ef"
54+
"sha512=c758448306f867e90203634b5e4e63b83b4c14ab293f5e0623fb2d3a852b4e944998b174a4b0ea758b098eef588aab92882095e28a59ed6b430677c0497fd70b"
55+
]
56+
}
57+
x-commit-hash: "12ad5b5ff2a37d24070553180167d9cdbe631b80"
58+

‎packages/odoc-parser/odoc-parser.3.0.0~beta1/opam‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
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 <jon@recoil.org>"]
8+
authors: ["Anton Bachin <antonbachin@yahoo.com>"]
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+
flags: [ avoid-version ]
15+
depends: [
16+
"dune" {>= "3.7"}
17+
"ocaml" {>= "4.02.0" & < "5.4"}
18+
"astring"
19+
"result"
20+
"camlp-streams"
21+
"ppx_expect" {with-test}
22+
("ocaml" {< "4.04.1" & with-test} | "sexplib0" {with-test})
23+
]
24+
build: [
25+
["dune" "subst"] {dev}
26+
[
27+
"dune"
28+
"build"
29+
"-p"
30+
name
31+
"-j"
32+
jobs
33+
"@install"
34+
# Tests are not all associated with a package and would be run if using the
35+
# default '@runtest'.
36+
"@src/parser/runtest" {with-test}
37+
]
38+
]
39+
x-maintenance-intent: ["(latest)"]
40+
url {
41+
src:
42+
"https://github.com/ocaml/odoc/releases/download/3.0.0_beta1/odoc-3.0.0.beta1.tbz"
43+
checksum: [
44+
"sha256=237473ccb54db660c0d476529268df4095a437906612f2ab5f01979852ca01ef"
45+
"sha512=c758448306f867e90203634b5e4e63b83b4c14ab293f5e0623fb2d3a852b4e944998b174a4b0ea758b098eef588aab92882095e28a59ed6b430677c0497fd70b"
46+
]
47+
}
48+
x-commit-hash: "12ad5b5ff2a37d24070553180167d9cdbe631b80"
49+

‎packages/odoc/odoc.3.0.0~beta1/opam‎

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
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+
flags: [ avoid-version ]
7+
8+
maintainer: [
9+
"Daniel Bünzli <daniel.buenzli@erratique.ch>"
10+
"Jon Ludlam <jon@recoil.org>"
11+
"Jules Aguillon <juloo.dsi@gmail.com>"
12+
"Paul-Elliot Anglès d'Auriac <paul-elliot@tarides.com>"
13+
]
14+
authors: [
15+
"Anton Bachin <antonbachin@yahoo.com>"
16+
"Daniel Bünzli <daniel.buenzli@erratique.ch>"
17+
"David Sheets <sheets@alum.mit.edu>"
18+
"Jon Ludlam <jon@recoil.org>"
19+
"Jules Aguillon <juloo.dsi@gmail.com>"
20+
"Leo White <leo@lpw25.net>"
21+
"Lubega Simon <lubegasimon73@gmail.com>"
22+
"Paul-Elliot Anglès d'Auriac <paul-elliot@tarides.com>"
23+
"Thomas Refis <trefis@janestreet.com>"
24+
]
25+
dev-repo: "git+https://github.com/ocaml/odoc.git"
26+
27+
synopsis: "OCaml Documentation Generator"
28+
description: """
29+
**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.
30+
31+
- **Output Formats:** Odoc generates HTML for web browsing, LaTeX for PDF generation, and man pages for use on Unix-like systems.
32+
- **Cross-References:** odoc uses the `ocamldoc` markup, which allows to create links for functions, types, modules, and documentation pages.
33+
- **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.
34+
- **Code Highlighting:** odoc automatically highlights syntax in code snippets for different languages.
35+
36+
odoc is part of the [OCaml Platform](https://ocaml.org/docs/platform), the recommended set of tools for OCaml.
37+
"""
38+
39+
40+
depends: [
41+
"odoc-parser" {= version}
42+
"astring"
43+
"cmdliner" {>= "1.0.0"}
44+
"cppo" {build & >= "1.1.0"}
45+
"dune" {>= "3.7.0"}
46+
"fpath"
47+
"ocaml" {>= "4.02.0" & < "5.4"}
48+
"result"
49+
"tyxml" {>= "4.4.0"}
50+
"fmt"
51+
52+
"ocamlfind" {with-test}
53+
"yojson" {>= "2.1.0"}
54+
("ocaml" {< "4.04.1" & with-test} | "sexplib0" {with-test})
55+
"conf-jq" {with-test}
56+
57+
"ppx_expect" {with-test}
58+
"bos" {with-test}
59+
"crunch" {> "2.0.0"}
60+
61+
("ocaml" {< "4.07.0" & with-test} | "bisect_ppx" {with-test & > "2.5.0"})
62+
]
63+
64+
conflicts: [ "ocaml-option-bytecode-only" ]
65+
66+
x-extra-doc-deps: [
67+
"odoc-driver" {= version}
68+
"sherlodoc" {= version}
69+
"odig"
70+
]
71+
72+
build: [
73+
["dune" "subst"] {dev}
74+
[
75+
"dune"
76+
"build"
77+
"-p"
78+
name
79+
"-j"
80+
jobs
81+
"@install"
82+
"@runtest" {with-test}
83+
"@doc" {with-doc}
84+
]
85+
]
86+
x-maintenance-intent: ["(latest)"]
87+
url {
88+
src:
89+
"https://github.com/ocaml/odoc/releases/download/3.0.0_beta1/odoc-3.0.0.beta1.tbz"
90+
checksum: [
91+
"sha256=237473ccb54db660c0d476529268df4095a437906612f2ab5f01979852ca01ef"
92+
"sha512=c758448306f867e90203634b5e4e63b83b4c14ab293f5e0623fb2d3a852b4e944998b174a4b0ea758b098eef588aab92882095e28a59ed6b430677c0497fd70b"
93+
]
94+
}
95+
x-commit-hash: "12ad5b5ff2a37d24070553180167d9cdbe631b80"
96+

‎packages/sherlodoc/sherlodoc.0.2/opam‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ bug-reports: "https://github.com/art-w/sherlodoc/issues"
99
depends: [
1010
"dune" {>= "3.5"}
1111
"ocaml" {>= "4.0.8"}
12-
"odoc" {>= "2.4.0"}
12+
"odoc" {>= "2.4.0" & < "2.9.0"}
1313
"base64" {>= "3.5.1"}
1414
"bigstringaf" {>= "0.9.1"}
1515
"js_of_ocaml" {>= "5.6.0"}

‎packages/sherlodoc/sherlodoc.3.0.0~beta1/opam‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
opam-version: "2.0"
2+
synopsis: "Search engine for OCaml documentation"
3+
maintainer: ["art.wendling@gmail.com"]
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+
flags: [ avoid-version ]
10+
depends: [
11+
"dune" {>= "3.7"}
12+
"ocaml" {>= "4.0.8"}
13+
"odoc" {= version}
14+
"base64" {>= "3.5.1"}
15+
"bigstringaf" {>= "0.9.1"}
16+
"js_of_ocaml" {>= "5.6.0"}
17+
"brr" {>= "0.0.6"}
18+
"cmdliner" {>= "1.2.0"}
19+
"decompress" {>= "1.5.3"}
20+
"fpath" {>= "0.7.3"}
21+
"lwt" {>= "5.7.0"}
22+
"menhir" {>= "20230608"}
23+
"ppx_blob" {>= "0.9.0"}
24+
"tyxml" {>= "4.6.0"}
25+
"result" {>= "1.5"}
26+
"odig" {with-test}
27+
"base" {with-test & = "v0.16.3"}
28+
"alcotest" {with-test}
29+
]
30+
depopts: [
31+
"ancient" {>= "0.9.1"}
32+
]
33+
build: [
34+
["dune" "subst"] {dev}
35+
[
36+
"dune"
37+
"build"
38+
"-p"
39+
name
40+
"-j"
41+
jobs
42+
"@install"
43+
"@sherlodoc/runtest" {with-test}
44+
"@doc" {with-doc}
45+
]
46+
]
47+
dev-repo: "git+https://github.com/ocaml/odoc.git"
48+
x-maintenance-intent: ["(latest)"]
49+
url {
50+
src:
51+
"https://github.com/ocaml/odoc/releases/download/3.0.0_beta1/odoc-3.0.0.beta1.tbz"
52+
checksum: [
53+
"sha256=237473ccb54db660c0d476529268df4095a437906612f2ab5f01979852ca01ef"
54+
"sha512=c758448306f867e90203634b5e4e63b83b4c14ab293f5e0623fb2d3a852b4e944998b174a4b0ea758b098eef588aab92882095e28a59ed6b430677c0497fd70b"
55+
]
56+
}
57+
x-commit-hash: "12ad5b5ff2a37d24070553180167d9cdbe631b80"
58+

0 commit comments

Comments
 (0)