Skip to content

Commit

Permalink
[new release] odoc and odoc-parser (2.4.0)
Browse files Browse the repository at this point in the history
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)
  • Loading branch information
Julow committed Dec 12, 2023
1 parent 18a778e commit 8f196bb
Show file tree
Hide file tree
Showing 2 changed files with 128 additions and 0 deletions.
44 changes: 44 additions & 0 deletions packages/odoc-parser/odoc-parser.2.4.0/opam
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
opam-version: "2.0"
synopsis: "Parser for ocaml documentation comments"
description: """
Odoc_parser is a library for parsing the contents of OCaml documentation
comments, formatted using 'odoc' syntax, an extension of the language
understood by ocamldoc."""
maintainer: ["Jon Ludlam <[email protected]>"]
authors: ["Anton Bachin <[email protected]>"]
license: "ISC"
homepage: "https://github.com/ocaml/odoc"
bug-reports: "https://github.com/ocaml/odoc/issues"
dev-repo: "git+https://github.com/ocaml/odoc.git"
doc: "https://ocaml.github.io/odoc/odoc_parser"
depends: [
"dune" {>= "3.7"}
"ocaml" {>= "4.02.0"}
"astring"
"result"
"camlp-streams"
"ppx_expect" {with-test}
("ocaml" {< "4.04.1" & with-test} | "sexplib0" {with-test})
]
build: [
["dune" "subst"] {dev}
[
"dune"
"build"
"-p"
name
"-j"
jobs
"@install"
"@runtest" {with-test}
]
]
url {
src: "https://github.com/ocaml/odoc/releases/download/2.4.0/odoc-2.4.0.tbz"
checksum: [
"sha256=55a5d481a32dc9917fa5537dd09ab37b7d3c965ff4dc24ac7aff903ba26ecce1"
"sha512=56e0e260f2c80ee338077a02afa69e093ee0016251fa258c970a06325a7701ccf93bf54ba486cdc9fbd09bf1fbbe7e78f56e1a0f53ece776a79ca277a0f78b9c"
]
}
x-commit-hash: "cc517bdb5f075284ba0a108e8714eb505874ef5b"

84 changes: 84 additions & 0 deletions packages/odoc/odoc.2.4.0/opam
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
opam-version: "2.0"
homepage: "https://github.com/ocaml/odoc"
doc: "https://ocaml.github.io/odoc/"
bug-reports: "https://github.com/ocaml/odoc/issues"
license: "ISC"

maintainer: [
"Daniel Bünzli <[email protected]>"
"Jon Ludlam <[email protected]>"
"Jules Aguillon <[email protected]>"
"Paul-Elliot Anglès d'Auriac <[email protected]>"
]
authors: [
"Anton Bachin <[email protected]>"
"Daniel Bünzli <[email protected]>"
"David Sheets <[email protected]>"
"Jon Ludlam <[email protected]>"
"Jules Aguillon <[email protected]>"
"Leo White <[email protected]>"
"Lubega Simon <[email protected]>"
"Paul-Elliot Anglès d'Auriac <[email protected]>"
"Thomas Refis <[email protected]>"
]
dev-repo: "git+https://github.com/ocaml/odoc.git"

synopsis: "OCaml Documentation Generator"
description: """
**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.

- **Output Formats:** Odoc generates HTML for web browsing, LaTeX for PDF generation, and man pages for use on Unix-like systems.
- **Cross-References:** odoc uses the `ocamldoc` markup, which allows to create links for functions, types, modules, and documentation pages.
- **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.
- **Code Highlighting:** odoc automatically highlights syntax in code snippets for different languages.

odoc is part of the [OCaml Platform](https://ocaml.org/docs/platform), the recommended set of tools for OCaml.
"""


depends: [
"odoc-parser" {= version}
"astring"
"cmdliner" {>= "1.0.0"}
"cppo" {build & >= "1.1.0"}
"dune" {>= "3.7.0"}
"fpath"
"ocaml" {>= "4.02.0"}
"result"
"tyxml" {>= "4.4.0"}
"fmt"

"ocamlfind" {with-test}
"yojson" {>= "1.6.0" & with-test}
("ocaml" {< "4.04.1" & with-test} | "sexplib0" {with-test})
"conf-jq" {with-test}

"ppx_expect" {with-test}
"bos" {with-test}
"crunch"

("ocaml" {< "4.07.0" & with-test} | "bisect_ppx" {with-test & > "2.5.0"})
]

build: [
["dune" "subst"] {dev}
[
"dune"
"build"
"-p"
name
"-j"
jobs
"@install"
"@runtest" {with-test}
"@doc" {with-doc}
]
]
url {
src: "https://github.com/ocaml/odoc/releases/download/2.4.0/odoc-2.4.0.tbz"
checksum: [
"sha256=55a5d481a32dc9917fa5537dd09ab37b7d3c965ff4dc24ac7aff903ba26ecce1"
"sha512=56e0e260f2c80ee338077a02afa69e093ee0016251fa258c970a06325a7701ccf93bf54ba486cdc9fbd09bf1fbbe7e78f56e1a0f53ece776a79ca277a0f78b9c"
]
}
x-commit-hash: "cc517bdb5f075284ba0a108e8714eb505874ef5b"

0 comments on commit 8f196bb

Please sign in to comment.