this repo has no description

Merge pull request #27309 from jonludlam/release-odoc-3.0.0_beta1

[new release] odoc (5 packages) (3.0.0~beta1)

Changed files
+340 -1
packages
odoc
odoc.3.0.0~beta1
odoc-driver
odoc-driver.3.0.0~beta1
odoc-md
odoc-md.3.0.0~beta1
odoc-parser
odoc-parser.3.0.0~beta1
sherlodoc
sherlodoc.0.2
sherlodoc.3.0.0~beta1
+78
packages/odoc-driver/odoc-driver.3.0.0~beta1/opam
···
+
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"
+
flags: [ avoid-version ]
+
+
maintainer: [
+
"Daniel Bünzli <daniel.buenzli@erratique.ch>"
+
"Jon Ludlam <jon@recoil.org>"
+
"Jules Aguillon <juloo.dsi@gmail.com>"
+
"Paul-Elliot Anglès d'Auriac <paul-elliot@tarides.com>"
+
]
+
authors: [
+
"Anton Bachin <antonbachin@yahoo.com>"
+
"Daniel Bünzli <daniel.buenzli@erratique.ch>"
+
"David Sheets <sheets@alum.mit.edu>"
+
"Jon Ludlam <jon@recoil.org>"
+
"Jules Aguillon <juloo.dsi@gmail.com>"
+
"Leo White <leo@lpw25.net>"
+
"Lubega Simon <lubegasimon73@gmail.com>"
+
"Paul-Elliot Anglès d'Auriac <paul-elliot@tarides.com>"
+
"Thomas Refis <trefis@janestreet.com>"
+
]
+
dev-repo: "git+https://github.com/ocaml/odoc.git"
+
+
synopsis: "OCaml Documentation Generator - Driver"
+
description: """
+
The driver is a sample implementation of a tool to drive odoc to generate
+
documentation for installed packages.
+
"""
+
+
+
depends: [
+
"ocaml" {>= "5.1.0"}
+
"odoc" {= version}
+
"dune" {>= "3.7.0"}
+
"odoc-md"
+
"bos"
+
"fpath"
+
"yojson" {>= "2.0.0"}
+
"ocamlfind"
+
"opam-format" {>= "2.1.0"}
+
"logs"
+
"eio_main"
+
"eio" {>= "1.0"}
+
"progress"
+
"cmdliner" {>= "1.1.0"}
+
"sexplib"
+
"ppx_sexp_conv"
+
"sherlodoc"
+
]
+
+
build: [
+
["dune" "subst"] {dev}
+
[
+
"dune"
+
"build"
+
"-p"
+
name
+
"-j"
+
jobs
+
"@install"
+
"@doc" {with-doc}
+
]
+
]
+
+
x-maintenance-intent: ["(latest)"]
+
url {
+
src:
+
"https://github.com/ocaml/odoc/releases/download/3.0.0_beta1/odoc-3.0.0.beta1.tbz"
+
checksum: [
+
"sha256=237473ccb54db660c0d476529268df4095a437906612f2ab5f01979852ca01ef"
+
"sha512=c758448306f867e90203634b5e4e63b83b4c14ab293f5e0623fb2d3a852b4e944998b174a4b0ea758b098eef588aab92882095e28a59ed6b430677c0497fd70b"
+
]
+
}
+
x-commit-hash: "12ad5b5ff2a37d24070553180167d9cdbe631b80"
+
+58
packages/odoc-md/odoc-md.3.0.0~beta1/opam
···
+
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"
+
flags: [ avoid-version ]
+
+
maintainer: [
+
"Jon Ludlam <jon@recoil.org>"
+
"Jules Aguillon <juloo.dsi@gmail.com>"
+
"Paul-Elliot Anglès d'Auriac <paul-elliot@tarides.com>"
+
]
+
authors: [
+
"Daniel Bünzli <daniel.buenzli@erratique.ch>"
+
"Paul-Elliot Anglès d'Auriac <paul-elliot@tarides.com>"
+
"Jon Ludlam <jon@recoil.org>"
+
]
+
dev-repo: "git+https://github.com/ocaml/odoc.git"
+
+
synopsis: "OCaml Documentation Generator - Markdown support"
+
description: """
+
Odoc-md is part of the odoc suite of tools for generating documentation for OCaml packages.
+
+
This package provides support for generating documentation from Markdown files.
+
"""
+
+
depends: [
+
"ocaml" {>= "4.14.0"}
+
"odoc" {= version}
+
"dune" {>= "3.7.0"}
+
"cmarkit"
+
]
+
+
build: [
+
["dune" "subst"] {dev}
+
[
+
"dune"
+
"build"
+
"-p"
+
name
+
"-j"
+
jobs
+
"@install"
+
"@doc" {with-doc}
+
]
+
]
+
+
x-maintenance-intent: ["(latest)"]
+
url {
+
src:
+
"https://github.com/ocaml/odoc/releases/download/3.0.0_beta1/odoc-3.0.0.beta1.tbz"
+
checksum: [
+
"sha256=237473ccb54db660c0d476529268df4095a437906612f2ab5f01979852ca01ef"
+
"sha512=c758448306f867e90203634b5e4e63b83b4c14ab293f5e0623fb2d3a852b4e944998b174a4b0ea758b098eef588aab92882095e28a59ed6b430677c0497fd70b"
+
]
+
}
+
x-commit-hash: "12ad5b5ff2a37d24070553180167d9cdbe631b80"
+
+49
packages/odoc-parser/odoc-parser.3.0.0~beta1/opam
···
+
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 <jon@recoil.org>"]
+
authors: ["Anton Bachin <antonbachin@yahoo.com>"]
+
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"
+
flags: [ avoid-version ]
+
depends: [
+
"dune" {>= "3.7"}
+
"ocaml" {>= "4.02.0" & < "5.4"}
+
"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}
+
]
+
]
+
x-maintenance-intent: ["(latest)"]
+
url {
+
src:
+
"https://github.com/ocaml/odoc/releases/download/3.0.0_beta1/odoc-3.0.0.beta1.tbz"
+
checksum: [
+
"sha256=237473ccb54db660c0d476529268df4095a437906612f2ab5f01979852ca01ef"
+
"sha512=c758448306f867e90203634b5e4e63b83b4c14ab293f5e0623fb2d3a852b4e944998b174a4b0ea758b098eef588aab92882095e28a59ed6b430677c0497fd70b"
+
]
+
}
+
x-commit-hash: "12ad5b5ff2a37d24070553180167d9cdbe631b80"
+
+96
packages/odoc/odoc.3.0.0~beta1/opam
···
+
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"
+
flags: [ avoid-version ]
+
+
maintainer: [
+
"Daniel Bünzli <daniel.buenzli@erratique.ch>"
+
"Jon Ludlam <jon@recoil.org>"
+
"Jules Aguillon <juloo.dsi@gmail.com>"
+
"Paul-Elliot Anglès d'Auriac <paul-elliot@tarides.com>"
+
]
+
authors: [
+
"Anton Bachin <antonbachin@yahoo.com>"
+
"Daniel Bünzli <daniel.buenzli@erratique.ch>"
+
"David Sheets <sheets@alum.mit.edu>"
+
"Jon Ludlam <jon@recoil.org>"
+
"Jules Aguillon <juloo.dsi@gmail.com>"
+
"Leo White <leo@lpw25.net>"
+
"Lubega Simon <lubegasimon73@gmail.com>"
+
"Paul-Elliot Anglès d'Auriac <paul-elliot@tarides.com>"
+
"Thomas Refis <trefis@janestreet.com>"
+
]
+
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" & < "5.4"}
+
"result"
+
"tyxml" {>= "4.4.0"}
+
"fmt"
+
+
"ocamlfind" {with-test}
+
"yojson" {>= "2.1.0"}
+
("ocaml" {< "4.04.1" & with-test} | "sexplib0" {with-test})
+
"conf-jq" {with-test}
+
+
"ppx_expect" {with-test}
+
"bos" {with-test}
+
"crunch" {> "2.0.0"}
+
+
("ocaml" {< "4.07.0" & with-test} | "bisect_ppx" {with-test & > "2.5.0"})
+
]
+
+
conflicts: [ "ocaml-option-bytecode-only" ]
+
+
x-extra-doc-deps: [
+
"odoc-driver" {= version}
+
"sherlodoc" {= version}
+
"odig"
+
]
+
+
build: [
+
["dune" "subst"] {dev}
+
[
+
"dune"
+
"build"
+
"-p"
+
name
+
"-j"
+
jobs
+
"@install"
+
"@runtest" {with-test}
+
"@doc" {with-doc}
+
]
+
]
+
x-maintenance-intent: ["(latest)"]
+
url {
+
src:
+
"https://github.com/ocaml/odoc/releases/download/3.0.0_beta1/odoc-3.0.0.beta1.tbz"
+
checksum: [
+
"sha256=237473ccb54db660c0d476529268df4095a437906612f2ab5f01979852ca01ef"
+
"sha512=c758448306f867e90203634b5e4e63b83b4c14ab293f5e0623fb2d3a852b4e944998b174a4b0ea758b098eef588aab92882095e28a59ed6b430677c0497fd70b"
+
]
+
}
+
x-commit-hash: "12ad5b5ff2a37d24070553180167d9cdbe631b80"
+
+1 -1
packages/sherlodoc/sherlodoc.0.2/opam
···
depends: [
"dune" {>= "3.5"}
"ocaml" {>= "4.0.8"}
-
"odoc" {>= "2.4.0"}
+
"odoc" {>= "2.4.0" & < "2.9.0"}
"base64" {>= "3.5.1"}
"bigstringaf" {>= "0.9.1"}
"js_of_ocaml" {>= "5.6.0"}
+58
packages/sherlodoc/sherlodoc.3.0.0~beta1/opam
···
+
opam-version: "2.0"
+
synopsis: "Search engine for OCaml documentation"
+
maintainer: ["art.wendling@gmail.com"]
+
authors: ["Arthur Wendling" "Emile Trotignon"]
+
license: "MIT"
+
homepage: "https://github.com/ocaml/odoc"
+
doc: "https://ocaml.github.io/odoc/"
+
bug-reports: "https://github.com/ocaml/odoc/issues"
+
flags: [ avoid-version ]
+
depends: [
+
"dune" {>= "3.7"}
+
"ocaml" {>= "4.0.8"}
+
"odoc" {= version}
+
"base64" {>= "3.5.1"}
+
"bigstringaf" {>= "0.9.1"}
+
"js_of_ocaml" {>= "5.6.0"}
+
"brr" {>= "0.0.6"}
+
"cmdliner" {>= "1.2.0"}
+
"decompress" {>= "1.5.3"}
+
"fpath" {>= "0.7.3"}
+
"lwt" {>= "5.7.0"}
+
"menhir" {>= "20230608"}
+
"ppx_blob" {>= "0.9.0"}
+
"tyxml" {>= "4.6.0"}
+
"result" {>= "1.5"}
+
"odig" {with-test}
+
"base" {with-test & = "v0.16.3"}
+
"alcotest" {with-test}
+
]
+
depopts: [
+
"ancient" {>= "0.9.1"}
+
]
+
build: [
+
["dune" "subst"] {dev}
+
[
+
"dune"
+
"build"
+
"-p"
+
name
+
"-j"
+
jobs
+
"@install"
+
"@sherlodoc/runtest" {with-test}
+
"@doc" {with-doc}
+
]
+
]
+
dev-repo: "git+https://github.com/ocaml/odoc.git"
+
x-maintenance-intent: ["(latest)"]
+
url {
+
src:
+
"https://github.com/ocaml/odoc/releases/download/3.0.0_beta1/odoc-3.0.0.beta1.tbz"
+
checksum: [
+
"sha256=237473ccb54db660c0d476529268df4095a437906612f2ab5f01979852ca01ef"
+
"sha512=c758448306f867e90203634b5e4e63b83b4c14ab293f5e0623fb2d3a852b4e944998b174a4b0ea758b098eef588aab92882095e28a59ed6b430677c0497fd70b"
+
]
+
}
+
x-commit-hash: "12ad5b5ff2a37d24070553180167d9cdbe631b80"
+