Skip to content

Commit b26d770

Browse files
JulowJulow
committed
[new release] odoc and odoc-parser (2.4.0)
CHANGES: ### Added - Add support for external search engines (@panglesd, @EmileTrotignon, ocaml/odoc#972) This includes the generation of an index and the display of the results in the UI (HTML only). - Display 'private' keyword for private type extensions (@gpetiot, ocaml/odoc#1019) - Allow to omit parent type in constructor reference (@panglesd, @EmileTrotignon, ocaml/odoc#933) ### Fixed - Warn and exit when table(s) is not closed (@lubegasimon, ocaml/odoc#1050) - Hint when list(s) is not closed (@lubegasimon, ocaml/odoc#1050) - Fix crash on functors returning an alias (@Julow, ocaml/odoc#1046) - Fix rendering of polymorphic variants (@wikku, @panglesd, ocaml/odoc#971) - Add references to extension declarations (@gpetiot, @panglesd, ocaml/odoc#949) ### Changed - Style: Adjusted line height in the TOC to improve readability (@sorawee, ocaml/odoc#1045) - Style: Remove font fallback to Helvetica, Arial (@Julow, ocaml/odoc#1028) - Style: Preformatted elements fallback to UA monospace (@toastal, ocaml/odoc#967) - Style: Sidebar is now stuck to the left of the content instead of the left of the viewport (@EmileTrotignon, ocaml/odoc#999)
1 parent 18a778e commit b26d770

File tree

2 files changed

+128
-0
lines changed
  • packages
    • odoc-parser/odoc-parser.2.4.0
    • odoc/odoc.2.4.0

2 files changed

+128
-0
lines changed

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

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
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.7"}
16+
"ocaml" {>= "4.02.0"}
17+
"astring"
18+
"result"
19+
"camlp-streams"
20+
"ppx_expect" {with-test}
21+
("ocaml" {< "4.04.1" & with-test} | "sexplib0" {with-test})
22+
]
23+
build: [
24+
["dune" "subst"] {dev}
25+
[
26+
"dune"
27+
"build"
28+
"-p"
29+
name
30+
"-j"
31+
jobs
32+
"@install"
33+
"@runtest" {with-test}
34+
]
35+
]
36+
url {
37+
src: "https://github.com/ocaml/odoc/releases/download/2.4.0/odoc-2.4.0.tbz"
38+
checksum: [
39+
"sha256=1be63699b761fe051df743fc77862559b17a1578a21c4d5098170c6f02503dce"
40+
"sha512=ad5235765264e3117f8848b5982738573c8c967338e62fa9282baafd65b2b8a1b6f057fe0fc4ce7e40251ce381db5da23b62a27f3ceda1510b25407dc6c61a09"
41+
]
42+
}
43+
x-commit-hash: "74692c029b43dc379e6da04458e14a199c94d386"
44+

‎packages/odoc/odoc.2.4.0/opam

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
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.0.0"}
43+
"cppo" {build & >= "1.1.0"}
44+
"dune" {>= "3.7.0"}
45+
"fpath"
46+
"ocaml" {>= "4.02.0"}
47+
"result"
48+
"tyxml" {>= "4.4.0"}
49+
"fmt"
50+
51+
"ocamlfind" {with-test}
52+
"yojson" {>= "1.6.0" & with-test}
53+
("ocaml" {< "4.04.1" & with-test} | "sexplib0" {with-test})
54+
"conf-jq" {with-test}
55+
56+
"ppx_expect" {with-test}
57+
"bos" {with-test}
58+
"crunch"
59+
60+
("ocaml" {< "4.07.0" & with-test} | "bisect_ppx" {with-test & > "2.5.0"})
61+
]
62+
63+
build: [
64+
["dune" "subst"] {dev}
65+
[
66+
"dune"
67+
"build"
68+
"-p"
69+
name
70+
"-j"
71+
jobs
72+
"@install"
73+
"@runtest" {with-test}
74+
"@doc" {with-doc}
75+
]
76+
]
77+
url {
78+
src: "https://github.com/ocaml/odoc/releases/download/2.4.0/odoc-2.4.0.tbz"
79+
checksum: [
80+
"sha256=1be63699b761fe051df743fc77862559b17a1578a21c4d5098170c6f02503dce"
81+
"sha512=ad5235765264e3117f8848b5982738573c8c967338e62fa9282baafd65b2b8a1b6f057fe0fc4ce7e40251ce381db5da23b62a27f3ceda1510b25407dc6c61a09"
82+
]
83+
}
84+
x-commit-hash: "74692c029b43dc379e6da04458e14a199c94d386"

0 commit comments

Comments
 (0)