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" {>= "2.1.0"}
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" {>= "1.4.1"}
59
60 ("ocaml" {< "4.07.0" & with-test} | "bisect_ppx" {with-test & > "2.5.0"})
61]
62
63conflicts: [ "ocaml-option-bytecode-only" ]
64
65x-extra-doc-deps: [
66 "odoc-driver" {= version}
67 "sherlodoc" {= version}
68 "odig"
69]
70
71build: [
72 ["dune" "subst"] {dev}
73 [
74 "dune"
75 "build"
76 "-p"
77 name
78 "-j"
79 jobs
80 "@install"
81 "@runtest" {with-test}
82 "@doc" {with-doc}
83 ]
84]
85x-maintenance-intent: ["(latest)"]
86url {
87 src: "https://github.com/ocaml/odoc/releases/download/3.0.0/odoc-3.0.0.tbz"
88 checksum: [
89 "sha256=ce84fa7e0cc5f3e8a54e6adeb10826152798b602057b9e46c5ae7e5d5206812b"
90 "sha512=9febd413450ca2e3824c9ef7e1c9ae8d8094aa72ed71327a69d8d6b42f6f197b3f3f40d674de0d11fa1242ee0df95c693b5d74467d530704e1339f3a523452f6"
91 ]
92}
93x-commit-hash: "90e679061f68c5e5ee5915e280f63d842f41f300"
94