this repo has no description
anil.recoil.org
1opam-version: "2.0"
2homepage: "https://github.com/ocaml/odoc"
3doc: "https://ocaml.github.io/odoc/"
4bug-reports: "https://github.com/ocaml/odoc/issues"
5license: "ISC"
6
7maintainer: [
8 "Daniel Bünzli <daniel.buenzli@erratique.ch>"
9 "Jon Ludlam <jon@recoil.org>"
10 "Jules Aguillon <juloo.dsi@gmail.com>"
11 "Paul-Elliot Anglès d'Auriac <paul-elliot@tarides.com>"
12]
13authors: [
14 "Anton Bachin <antonbachin@yahoo.com>"
15 "Daniel Bünzli <daniel.buenzli@erratique.ch>"
16 "David Sheets <sheets@alum.mit.edu>"
17 "Jon Ludlam <jon@recoil.org>"
18 "Jules Aguillon <juloo.dsi@gmail.com>"
19 "Leo White <leo@lpw25.net>"
20 "Lubega Simon <lubegasimon73@gmail.com>"
21 "Paul-Elliot Anglès d'Auriac <paul-elliot@tarides.com>"
22 "Thomas Refis <trefis@janestreet.com>"
23]
24dev-repo: "git+https://github.com/ocaml/odoc.git"
25
26synopsis: "OCaml Documentation Generator"
27description: """
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
35odoc is part of the [OCaml Platform](https://ocaml.org/docs/platform), the recommended set of tools for OCaml.
36"""
37
38
39depends: [
40 "odoc-parser" {= version}
41 "astring"
42 "cmdliner" {>= "1.0.0" & < "2.0.0"}
43 "cppo" {build & >= "1.1.0"}
44 "dune" {>= "3.7.0"}
45 "fpath"
46 "ocaml" {>= "4.02.0" & < "5.4"}
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" {> "2.0.0"}
59
60 ("ocaml" {< "4.07.0" & with-test} | "bisect_ppx" {with-test & > "2.5.0"})
61]
62
63build: [
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]
77url {
78 src: "https://github.com/ocaml/odoc/releases/download/2.4.4/odoc-2.4.4.tbz"
79 checksum: [
80 "sha256=7e253a55b5c8f610f9e0b48940ecdaf21c01553143af93b40c998c30499e51f3"
81 "sha512=d5b1e6786c9cb371cb207da91728336a4746c8f3f07d817bb8259b32404445cd99ba2455ad51cbaffedf98e24cec68743fb7b02ad44643b1718d3d875b5580ee"
82 ]
83}
84x-commit-hash: "795902d7ee58e86b599e45ed3e763792ee9bf13d"