-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #26565 from jonludlam/release-odoc-2.4.3
[new release] odoc and odoc-parser (2.4.3)
- Loading branch information
Showing
2 changed files
with
129 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
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} | ||
] | ||
] | ||
url { | ||
src: "https://github.com/ocaml/odoc/releases/download/2.4.3/odoc-2.4.3.tbz" | ||
checksum: [ | ||
"sha256=d6bb2cec05b4893ce787d7b7b16110b6583fcdcde840446710befbbf3bbb2b12" | ||
"sha512=e78faa68c726db3034c12f0cbf76efb87e73f03430a734f82eeea4fb8813e5ebb8ad176012ed20cc1d56a874c601489ca3f02c929474f925eec6d51ce6bdb856" | ||
] | ||
} | ||
x-commit-hash: "09a5562f7b61ed9e7512afdf87421dd17b6e4966" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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" {> "2.0.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.3/odoc-2.4.3.tbz" | ||
checksum: [ | ||
"sha256=d6bb2cec05b4893ce787d7b7b16110b6583fcdcde840446710befbbf3bbb2b12" | ||
"sha512=e78faa68c726db3034c12f0cbf76efb87e73f03430a734f82eeea4fb8813e5ebb8ad176012ed20cc1d56a874c601489ca3f02c929474f925eec6d51ce6bdb856" | ||
] | ||
} | ||
x-commit-hash: "09a5562f7b61ed9e7512afdf87421dd17b6e4966" |