Merge pull request #24930 from Julow/release-odoc-2.4.0

[new release] odoc and odoc-parser (2.4.0)

packages/odoc-parser/odoc-parser.2.4.0/files/0001-Don-t-make-parser-tests-installable.patch

@@ -0,0 +1,25 @@
+From a29977ba0ca1e5617a24bc8693d033a085563ff3 Mon Sep 17 00:00:00 2001
+From: Jules Aguillon <[email protected]>
+Date: Tue, 12 Dec 2023 15:53:06 +0100
+Subject: [PATCH] Don't make parser tests installable
+
+This makes the regular build of odoc-parser to depend on its
+test-dependencies, making it fail.
+---
+ src/parser/test/dune | 1 -
+ 1 file changed, 1 deletion(-)
+
+diff --git a/src/parser/test/dune b/src/parser/test/dune
+index 28c4d82f7..c6769550d 100644
+--- a/src/parser/test/dune
++++ b/src/parser/test/dune
+@@ -1,6 +1,5 @@
+ (library
+  (name odoc_parser_test)
+- (package odoc-parser)
+  (inline_tests)
+  (enabled_if
+   (>= %{ocaml_version} 4.04.1))
+-- 
+2.40.1
+

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

@@ -0,0 +1,48 @@
+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"
+    # Tests are not all associated with a package and would be run if using the
+    # default '@runtest'.
+    "@src/parser/runtest" {with-test}
+  ]
+]
+patches: [
+  "0001-Don-t-make-parser-tests-installable.patch"
+]
+url {
+  src: "https://github.com/ocaml/odoc/releases/download/2.4.0/odoc-2.4.0.tbz"
+  checksum: [
+    "sha256=fa52c66f12fe1bd63535776b5b0451112643446ef2171494e953859ef863959d"
+    "sha512=f55884d0ad788643b7137ee04cd57a1d33375ebf1f1aae32ef03b3a10f03b62723a6c05a31c2e0496794ad5d6d8794350935577a70ddfce3a061e28a49b24d82"
+  ]
+}
+x-commit-hash: "c8d3ba1604cd6a2bb7155afe10ecb596517e9e47"

packages/odoc/odoc.2.4.0/opam

@@ -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" {> "1.1.0"}
+
+  ("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=fa52c66f12fe1bd63535776b5b0451112643446ef2171494e953859ef863959d"
+    "sha512=f55884d0ad788643b7137ee04cd57a1d33375ebf1f1aae32ef03b3a10f03b62723a6c05a31c2e0496794ad5d6d8794350935577a70ddfce3a061e28a49b24d82"
+  ]
+}
+x-commit-hash: "c8d3ba1604cd6a2bb7155afe10ecb596517e9e47"