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"
6flags: [ avoid-version ]
7
8maintainer: [
9 "Daniel Bünzli <daniel.buenzli@erratique.ch>"
10 "Jon Ludlam <jon@recoil.org>"
11 "Jules Aguillon <juloo.dsi@gmail.com>"
12 "Paul-Elliot Anglès d'Auriac <paul-elliot@tarides.com>"
13]
14authors: [
15 "Anton Bachin <antonbachin@yahoo.com>"
16 "Daniel Bünzli <daniel.buenzli@erratique.ch>"
17 "David Sheets <sheets@alum.mit.edu>"
18 "Jon Ludlam <jon@recoil.org>"
19 "Jules Aguillon <juloo.dsi@gmail.com>"
20 "Leo White <leo@lpw25.net>"
21 "Lubega Simon <lubegasimon73@gmail.com>"
22 "Paul-Elliot Anglès d'Auriac <paul-elliot@tarides.com>"
23 "Thomas Refis <trefis@janestreet.com>"
24]
25dev-repo: "git+https://github.com/ocaml/odoc.git"
26
27synopsis: "OCaml Documentation Generator"
28description: """
29**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.
30
31- **Output Formats:** Odoc generates HTML for web browsing, LaTeX for PDF generation, and man pages for use on Unix-like systems.
32- **Cross-References:** odoc uses the `ocamldoc` markup, which allows to create links for functions, types, modules, and documentation pages.
33- **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.
34- **Code Highlighting:** odoc automatically highlights syntax in code snippets for different languages.
35
36odoc is part of the [OCaml Platform](https://ocaml.org/docs/platform), the recommended set of tools for OCaml.
37"""
38
39
40depends: [
41 "odoc-parser" {= version}
42 "astring"
43 "cmdliner" {>= "1.0.0" & < "2.0.0"}
44 "cppo" {build & >= "1.1.0"}
45 "dune" {>= "3.7.0"}
46 "fpath"
47 "ocaml" {>= "4.02.0" & < "5.4"}
48 "result"
49 "tyxml" {>= "4.4.0"}
50 "fmt"
51
52 "ocamlfind" {with-test}
53 "yojson" {>= "2.1.0"}
54 ("ocaml" {< "4.04.1" & with-test} | "sexplib0" {with-test})
55 "conf-jq" {with-test}
56
57 "ppx_expect" {with-test}
58 "bos" {with-test}
59 "crunch" {> "2.0.0"}
60
61 ("ocaml" {< "4.07.0" & with-test} | "bisect_ppx" {with-test & > "2.5.0"})
62]
63
64conflicts: [ "ocaml-option-bytecode-only" ]
65
66x-extra-doc-deps: [
67 "odoc-driver" {= version}
68 "sherlodoc" {= version}
69 "odig"
70]
71
72build: [
73 ["dune" "subst"] {dev}
74 [
75 "dune"
76 "build"
77 "-p"
78 name
79 "-j"
80 jobs
81 "@install"
82 "@runtest" {with-test}
83 "@doc" {with-doc}
84 ]
85]
86x-maintenance-intent: ["(latest)"]
87url {
88 src:
89 "https://github.com/ocaml/odoc/releases/download/3.0.0_beta1/odoc-3.0.0.beta1.tbz"
90 checksum: [
91 "sha256=237473ccb54db660c0d476529268df4095a437906612f2ab5f01979852ca01ef"
92 "sha512=c758448306f867e90203634b5e4e63b83b4c14ab293f5e0623fb2d3a852b4e944998b174a4b0ea758b098eef588aab92882095e28a59ed6b430677c0497fd70b"
93 ]
94}
95x-commit-hash: "12ad5b5ff2a37d24070553180167d9cdbe631b80"
96