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