|
| 1 | +opam-version: "2.0" |
| 2 | +homepage: "https://github.com/ocaml/odoc" |
| 3 | +doc: "https://ocaml.github.io/odoc/" |
| 4 | +bug-reports: "https://github.com/ocaml/odoc/issues" |
| 5 | +license: "ISC" |
| 6 | +flags: [ avoid-version ] |
| 7 | + |
| 8 | +maintainer: [ |
| 9 | + "Daniel Bünzli < [email protected]>" |
| 10 | + |
| 11 | + "Jules Aguillon < [email protected]>" |
| 12 | + "Paul-Elliot Anglès d'Auriac < [email protected]>" |
| 13 | +] |
| 14 | +authors: [ |
| 15 | + "Anton Bachin < [email protected]>" |
| 16 | + "Daniel Bünzli < [email protected]>" |
| 17 | + "David Sheets < [email protected]>" |
| 18 | + |
| 19 | + "Jules Aguillon < [email protected]>" |
| 20 | + |
| 21 | + "Lubega Simon < [email protected]>" |
| 22 | + "Paul-Elliot Anglès d'Auriac < [email protected]>" |
| 23 | + "Thomas Refis < [email protected]>" |
| 24 | +] |
| 25 | +dev-repo: "git+https://github.com/ocaml/odoc.git" |
| 26 | + |
| 27 | +synopsis: "OCaml Documentation Generator" |
| 28 | +description: """ |
| 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 | + |
| 36 | +odoc is part of the [OCaml Platform](https://ocaml.org/docs/platform), the recommended set of tools for OCaml. |
| 37 | +""" |
| 38 | + |
| 39 | + |
| 40 | +depends: [ |
| 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" {>= "1.4.1"} |
| 60 | + |
| 61 | + ("ocaml" {< "4.07.0" & with-test} | "bisect_ppx" {with-test & > "2.5.0"}) |
| 62 | +] |
| 63 | + |
| 64 | +conflicts: [ "ocaml-option-bytecode-only" ] |
| 65 | + |
| 66 | +x-extra-doc-deps: [ |
| 67 | + "odoc-driver" {= version} |
| 68 | + "sherlodoc" {= version} |
| 69 | + "odig" |
| 70 | +] |
| 71 | + |
| 72 | +build: [ |
| 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 | +] |
| 86 | +x-maintenance-intent: ["(latest)"] |
| 87 | +url { |
| 88 | + src: "https://github.com/ocaml/odoc/releases/download/3.0.0/odoc-3.0.0.tbz" |
| 89 | + checksum: [ |
| 90 | + "sha256=52e4cb5ae816568e7492c511c1af93d1c543e70c5b2de6ba47691d9fd224e543" |
| 91 | + "sha512=565eef31c66df5ae28c4bbf4b52e925d71b1f6c8e0c2e56b76ad13ceebc893f4c2418cc190295892de357c9d997da901a6657e5b3212d224261c2593d73f44ac" |
| 92 | + ] |
| 93 | +} |
| 94 | +x-commit-hash: "0e9920f106729d1793ade3d29151c02fc64d0ba6" |
| 95 | + |
0 commit comments