this repo has no description

[new release] odoc (5 packages) (3.0.0)

CHANGES:

- Hierarchical documentation (@jonludlam, @panglesd, @Julow). Pages can now be
organized in a directory tree structure. Relative and absolute references
are added: `{!./other_page.label}`, `{!//other_page}`.

- Improved sidebar and breadcrumbs navigation (@panglesd, @gpetiot). The
documentation pages and the libraries of the entire package are shown on the
left sidebar.

- Added support for images, videos, audio and other assets. The syntax is
`{image!/reference/to/asset}` or `{image:URL}` for images. The syntax for
`{video...}` and `{audio...}` is the same. (@panglesd, @EmileTrotignon,
ocaml/odoc#1170, ocaml/odoc#1171, ocaml/odoc#1184, ocaml/odoc#1185)

- Search using Sherlodoc (@panglesd, @EmileTrotignon, @Julow). A new search
bar that supports full-text and type-based search.

- Experimental driver (@jonludlam, @panglesd)
The driver builds the documentation for a collection of Opam packages using
the newer Odoc features. It supports linking external packages to ocaml.org
and markdown files.
This is experimental and will break in the future.

- Cross-package references (@panglesd, @Julow)
Pages and modules from other packages can be referenced:
`{!/otherpackage/page}`, `{!/otherpackage/Module.t}`.

- Option to remap links to other packages to ocaml.org or other site.
See the `--remap` option of the driver or the `--remap-file` option of
`odoc html-generate`. (@jonludlam, ocaml/odoc#1189, ocaml/odoc#1248)

- Option to compute occurrences of use of each identifiers
The commands `aggregate-occurrences` and `count-occurrences` are added.
(@panglesd, ocaml/odoc#976, ocaml/odoc#1076, ocaml/odoc#1206)

- Added an `extract-code` subcommand to extract code blocks from mld/mli files
(@panglesd, ocaml/odoc#1326)

- Added the `odoc classify` command (@jonludlam, ocaml/odoc#1121)
Helps driver detecting which modules belong to which libraries.
- Added `--warnings-tag` options to the CLI to silence warnings from a unit,
even if they end up being raised in another unit through expansion
(@jonludlam, ocaml/odoc#1260)
- Add clock emoji before `@since` tag (@yawaramin, ocaml/odoc#1089)
- Navigation for the search bar : use '/' to enter search, up and down arrows
to select a result, and enter to follow the selected link. (@EmileTrotignon,
ocaml/odoc#1088)
- Fix a big gap between the preamble and the content of a page
(@EmileTrotignon, ocaml/odoc#1147)
- Add a marshalled search index consumable by sherlodoc (@EmileTrotignon,
@panglesd, ocaml/odoc#1084)
- Allow referencing of polymorphic constructors in polymorphic variant type
aliases (@panglesd, ocaml/odoc#1115)
- Added a home icon in the breacrumbs (@panglesd, ocaml/odoc#1251)
It can be disabled with a CLI option.
- Add a frontmatter syntax for mld pages (@panglesd, ocaml/odoc#1187, ocaml/odoc#1193, ocaml/odoc#1243,
ocaml/odoc#1246, ocaml/odoc#1251) Allows to specify the title of a page, the order of sub-pages
and other behaviors in the sidebar.
- Added `odoc-md` to process standalone Markdown pages (@jonludlam, ocaml/odoc#1234)
- Added CSS selectors to style version and and nav links when they appear
within page titles, as produced by odig (@katrinafyi, ocaml/odoc#1290)
- Added support for (local) images in the latex backend (@Octachron, ocaml/odoc#1297)

- The command line interface changed to support the new features.
+ Packages and libraries: `odoc link` must now be aware of packages and
libraries with the `-L libname:path` and `-P pkgname:path` options. The
module search path should still be passed with the `-I` option.
The current package should be specified with `--current-package=pkgname`.
+ Hierarchy: `odoc compile` now outputs `.odoc` in the directory tree
specified with `--output-dir=DIR` and the parent identifier must be
specified with `--parent-id=PARENT`.
The option `--source-parent-file` is removed.
+ Source code: Implementations are compiled with `compile-impl` instead of
with `compile`. The options `--cmt=..` and `--source-name=..` are removed.
Source code pages are generated with `html-generate-source`.
+ Assets: The commands `compile-asset`, `html-generate-asset` are added.
The option `html-generate --asset` is removed.
+ Sidebar: The index is built using `compile-index`. The sidebar data is
extracted from the index with `sidebar-generate` and passed to
`html-generate --sidebar=..`.

- The syntax for `@tag` is now delimited (@panglesd, ocaml/odoc#1239)
A `@tag` can now be followed by a paragraph or other elements.

- Updated colors for code fragments (@EmileTrotignon, ocaml/odoc#1023)
- Fixed complexity of looking up `.odoc` files (@panglesd, ocaml/odoc#1075)
- Normalize whitespaces in codespans (@gpetiot, ocaml/odoc#1085)
A newline followed by any whitespaces is normalized as one space character.
- Reduce size of `Odoc_html_frontend` when compiled to javascript
(@EmileTrotignon, ocaml/odoc#1072)
- Overhaul of module-type-of expansions and shadowing code (@jonludlam, ocaml/odoc#1081)
- Output file paths and labels in the man and latex backends changed to avoid
name clashes (@Julow, ocaml/odoc#1191)
- Added a `header` field to the json output (@panglesd, ocaml/odoc#1314)
- Changed indentation rules for code block and verbatim content (@panglesd,
ocaml/odoc#1317)
- odoc-parser: Store raw content in verbatim and code block, and expose a
function to process it (@panglesd, ocaml/odoc#1325)

- Fix variant constructors being hidden if they contain hidden types
(@jonludlam, ocaml/odoc#1105)
- Fix rare assertion failure due to optional parameters
(@jonludlam, ocaml/odoc#1272, issue ocaml/odoc#1001)
- Fix resolution of module synopses in {!modules} lists that require --open
(@jonludlam, ocaml/odoc#1104}
- Fix top comment not being taken from includes often enough (@panglesd, ocaml/odoc#1117)
- Fixed 404 links from search results (@panglesd, ocaml/odoc#1108)
- Fixed title content not being picked up across pages when rendering references
(ocaml/odoc#1116, @panglesd)
- Fix wrong links to standalone comments in search results (ocaml/odoc#1118, @panglesd)
- Remove duplicated or unwanted comments with inline includes (@Julow, ocaml/odoc#1133)
- Fix bug where source rendering would cause odoc to fail completely if it
encounters invalid syntax (@jonludlam ocaml/odoc#1208)
- Add missing parentheses in 'val (let*) : ...' (@Julow, ocaml/odoc#1268)
- Fix syntax highlighting not working for very large files
(@jonludlam, @Julow, ocaml/odoc#1277)
- Fix backtrace on invalid input in compile-deps (@jonludlam, ocaml/odoc#1313)
- Fix bug in our CSS hitting verbatim blocks in tags (@jonludlam, ocaml/odoc#1312)
- Fix issue ocaml/odoc#610 where `odoc html-fragment` wasn't rendering headings correctly
(@jonludlam, ocaml/odoc#1306)

Changed files
+329
packages
odoc
odoc.3.0.0
odoc-driver
odoc-driver.3.0.0
odoc-md
odoc-md.3.0.0
odoc-parser
odoc-parser.3.0.0
sherlodoc
sherlodoc.3.0.0
+76
packages/odoc-driver/odoc-driver.3.0.0/opam
···
+
opam-version: "2.0"
+
homepage: "https://github.com/ocaml/odoc"
+
doc: "https://ocaml.github.io/odoc/"
+
bug-reports: "https://github.com/ocaml/odoc/issues"
+
license: "ISC"
+
+
maintainer: [
+
"Daniel Bünzli <daniel.buenzli@erratique.ch>"
+
"Jon Ludlam <jon@recoil.org>"
+
"Jules Aguillon <juloo.dsi@gmail.com>"
+
"Paul-Elliot Anglès d'Auriac <paul-elliot@tarides.com>"
+
]
+
authors: [
+
"Anton Bachin <antonbachin@yahoo.com>"
+
"Daniel Bünzli <daniel.buenzli@erratique.ch>"
+
"David Sheets <sheets@alum.mit.edu>"
+
"Jon Ludlam <jon@recoil.org>"
+
"Jules Aguillon <juloo.dsi@gmail.com>"
+
"Leo White <leo@lpw25.net>"
+
"Lubega Simon <lubegasimon73@gmail.com>"
+
"Paul-Elliot Anglès d'Auriac <paul-elliot@tarides.com>"
+
"Thomas Refis <trefis@janestreet.com>"
+
]
+
dev-repo: "git+https://github.com/ocaml/odoc.git"
+
+
synopsis: "OCaml Documentation Generator - Driver"
+
description: """
+
The driver is a sample implementation of a tool to drive odoc to generate
+
documentation for installed packages.
+
"""
+
+
+
depends: [
+
"ocaml" {>= "5.1.0"}
+
"odoc" {= version}
+
"dune" {>= "3.7.0"}
+
"odoc-md"
+
"bos"
+
"fpath"
+
"yojson" {>= "2.0.0"}
+
"ocamlfind"
+
"opam-format" {>= "2.1.0"}
+
"logs"
+
"eio_main"
+
"eio" {>= "1.0"}
+
"progress"
+
"cmdliner" {>= "1.1.0"}
+
"sexplib"
+
"ppx_sexp_conv"
+
"sherlodoc"
+
]
+
+
build: [
+
["dune" "subst"] {dev}
+
[
+
"dune"
+
"build"
+
"-p"
+
name
+
"-j"
+
jobs
+
"@install"
+
"@doc" {with-doc}
+
]
+
]
+
+
x-maintenance-intent: ["(latest)"]
+
url {
+
src: "https://github.com/ocaml/odoc/releases/download/3.0.0/odoc-3.0.0.tbz"
+
checksum: [
+
"sha256=ce84fa7e0cc5f3e8a54e6adeb10826152798b602057b9e46c5ae7e5d5206812b"
+
"sha512=9febd413450ca2e3824c9ef7e1c9ae8d8094aa72ed71327a69d8d6b42f6f197b3f3f40d674de0d11fa1242ee0df95c693b5d74467d530704e1339f3a523452f6"
+
]
+
}
+
x-commit-hash: "90e679061f68c5e5ee5915e280f63d842f41f300"
+
+56
packages/odoc-md/odoc-md.3.0.0/opam
···
+
opam-version: "2.0"
+
homepage: "https://github.com/ocaml/odoc"
+
doc: "https://ocaml.github.io/odoc/"
+
bug-reports: "https://github.com/ocaml/odoc/issues"
+
license: "ISC"
+
+
maintainer: [
+
"Jon Ludlam <jon@recoil.org>"
+
"Jules Aguillon <juloo.dsi@gmail.com>"
+
"Paul-Elliot Anglès d'Auriac <paul-elliot@tarides.com>"
+
]
+
authors: [
+
"Daniel Bünzli <daniel.buenzli@erratique.ch>"
+
"Paul-Elliot Anglès d'Auriac <paul-elliot@tarides.com>"
+
"Jon Ludlam <jon@recoil.org>"
+
]
+
dev-repo: "git+https://github.com/ocaml/odoc.git"
+
+
synopsis: "OCaml Documentation Generator - Markdown support"
+
description: """
+
Odoc-md is part of the odoc suite of tools for generating documentation for OCaml packages.
+
+
This package provides support for generating documentation from Markdown files.
+
"""
+
+
depends: [
+
"ocaml" {>= "4.14.0"}
+
"odoc" {= version}
+
"dune" {>= "3.7.0"}
+
"cmarkit"
+
]
+
+
build: [
+
["dune" "subst"] {dev}
+
[
+
"dune"
+
"build"
+
"-p"
+
name
+
"-j"
+
jobs
+
"@install"
+
"@doc" {with-doc}
+
]
+
]
+
+
x-maintenance-intent: ["(latest)"]
+
url {
+
src: "https://github.com/ocaml/odoc/releases/download/3.0.0/odoc-3.0.0.tbz"
+
checksum: [
+
"sha256=ce84fa7e0cc5f3e8a54e6adeb10826152798b602057b9e46c5ae7e5d5206812b"
+
"sha512=9febd413450ca2e3824c9ef7e1c9ae8d8094aa72ed71327a69d8d6b42f6f197b3f3f40d674de0d11fa1242ee0df95c693b5d74467d530704e1339f3a523452f6"
+
]
+
}
+
x-commit-hash: "90e679061f68c5e5ee5915e280f63d842f41f300"
+
+47
packages/odoc-parser/odoc-parser.3.0.0/opam
···
+
opam-version: "2.0"
+
synopsis: "Parser for ocaml documentation comments"
+
description: """
+
Odoc_parser is a library for parsing the contents of OCaml documentation
+
comments, formatted using 'odoc' syntax, an extension of the language
+
understood by ocamldoc."""
+
maintainer: ["Jon Ludlam <jon@recoil.org>"]
+
authors: ["Anton Bachin <antonbachin@yahoo.com>"]
+
license: "ISC"
+
homepage: "https://github.com/ocaml/odoc"
+
bug-reports: "https://github.com/ocaml/odoc/issues"
+
dev-repo: "git+https://github.com/ocaml/odoc.git"
+
doc: "https://ocaml.github.io/odoc/odoc_parser"
+
depends: [
+
"dune" {>= "3.7"}
+
"ocaml" {>= "4.02.0" & < "5.4"}
+
"astring"
+
"result"
+
"camlp-streams"
+
"ppx_expect" {with-test}
+
("ocaml" {< "4.04.1" & with-test} | "sexplib0" {with-test})
+
]
+
build: [
+
["dune" "subst"] {dev}
+
[
+
"dune"
+
"build"
+
"-p"
+
name
+
"-j"
+
jobs
+
"@install"
+
# Tests are not all associated with a package and would be run if using the
+
# default '@runtest'.
+
"@src/parser/runtest" {with-test}
+
]
+
]
+
x-maintenance-intent: ["(latest)"]
+
url {
+
src: "https://github.com/ocaml/odoc/releases/download/3.0.0/odoc-3.0.0.tbz"
+
checksum: [
+
"sha256=ce84fa7e0cc5f3e8a54e6adeb10826152798b602057b9e46c5ae7e5d5206812b"
+
"sha512=9febd413450ca2e3824c9ef7e1c9ae8d8094aa72ed71327a69d8d6b42f6f197b3f3f40d674de0d11fa1242ee0df95c693b5d74467d530704e1339f3a523452f6"
+
]
+
}
+
x-commit-hash: "90e679061f68c5e5ee5915e280f63d842f41f300"
+
+94
packages/odoc/odoc.3.0.0/opam
···
+
opam-version: "2.0"
+
homepage: "https://github.com/ocaml/odoc"
+
doc: "https://ocaml.github.io/odoc/"
+
bug-reports: "https://github.com/ocaml/odoc/issues"
+
license: "ISC"
+
+
maintainer: [
+
"Daniel Bünzli <daniel.buenzli@erratique.ch>"
+
"Jon Ludlam <jon@recoil.org>"
+
"Jules Aguillon <juloo.dsi@gmail.com>"
+
"Paul-Elliot Anglès d'Auriac <paul-elliot@tarides.com>"
+
]
+
authors: [
+
"Anton Bachin <antonbachin@yahoo.com>"
+
"Daniel Bünzli <daniel.buenzli@erratique.ch>"
+
"David Sheets <sheets@alum.mit.edu>"
+
"Jon Ludlam <jon@recoil.org>"
+
"Jules Aguillon <juloo.dsi@gmail.com>"
+
"Leo White <leo@lpw25.net>"
+
"Lubega Simon <lubegasimon73@gmail.com>"
+
"Paul-Elliot Anglès d'Auriac <paul-elliot@tarides.com>"
+
"Thomas Refis <trefis@janestreet.com>"
+
]
+
dev-repo: "git+https://github.com/ocaml/odoc.git"
+
+
synopsis: "OCaml Documentation Generator"
+
description: """
+
**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.
+
+
- **Output Formats:** Odoc generates HTML for web browsing, LaTeX for PDF generation, and man pages for use on Unix-like systems.
+
- **Cross-References:** odoc uses the `ocamldoc` markup, which allows to create links for functions, types, modules, and documentation pages.
+
- **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.
+
- **Code Highlighting:** odoc automatically highlights syntax in code snippets for different languages.
+
+
odoc is part of the [OCaml Platform](https://ocaml.org/docs/platform), the recommended set of tools for OCaml.
+
"""
+
+
+
depends: [
+
"odoc-parser" {= version}
+
"astring"
+
"cmdliner" {>= "1.0.0" & < "2.0.0"}
+
"cppo" {build & >= "1.1.0"}
+
"dune" {>= "3.7.0"}
+
"fpath"
+
"ocaml" {>= "4.02.0" & < "5.4"}
+
"result"
+
"tyxml" {>= "4.4.0"}
+
"fmt"
+
+
"ocamlfind" {with-test}
+
"yojson" {>= "2.1.0"}
+
("ocaml" {< "4.04.1" & with-test} | "sexplib0" {with-test})
+
"conf-jq" {with-test}
+
+
"ppx_expect" {with-test}
+
"bos" {with-test}
+
"crunch" {>= "1.4.1"}
+
+
("ocaml" {< "4.07.0" & with-test} | "bisect_ppx" {with-test & > "2.5.0"})
+
]
+
+
conflicts: [ "ocaml-option-bytecode-only" ]
+
+
x-extra-doc-deps: [
+
"odoc-driver" {= version}
+
"sherlodoc" {= version}
+
"odig"
+
]
+
+
build: [
+
["dune" "subst"] {dev}
+
[
+
"dune"
+
"build"
+
"-p"
+
name
+
"-j"
+
jobs
+
"@install"
+
"@runtest" {with-test}
+
"@doc" {with-doc}
+
]
+
]
+
x-maintenance-intent: ["(latest)"]
+
url {
+
src: "https://github.com/ocaml/odoc/releases/download/3.0.0/odoc-3.0.0.tbz"
+
checksum: [
+
"sha256=ce84fa7e0cc5f3e8a54e6adeb10826152798b602057b9e46c5ae7e5d5206812b"
+
"sha512=9febd413450ca2e3824c9ef7e1c9ae8d8094aa72ed71327a69d8d6b42f6f197b3f3f40d674de0d11fa1242ee0df95c693b5d74467d530704e1339f3a523452f6"
+
]
+
}
+
x-commit-hash: "90e679061f68c5e5ee5915e280f63d842f41f300"
+
+56
packages/sherlodoc/sherlodoc.3.0.0/opam
···
+
opam-version: "2.0"
+
synopsis: "Search engine for OCaml documentation"
+
maintainer: ["art.wendling@gmail.com"]
+
authors: ["Arthur Wendling" "Emile Trotignon"]
+
license: "MIT"
+
homepage: "https://github.com/ocaml/odoc"
+
doc: "https://ocaml.github.io/odoc/"
+
bug-reports: "https://github.com/ocaml/odoc/issues"
+
depends: [
+
"dune" {>= "3.7"}
+
"ocaml" {>= "4.0.8"}
+
"odoc" {= version}
+
"base64" {>= "3.5.1"}
+
"bigstringaf" {>= "0.9.1"}
+
"js_of_ocaml" {>= "5.6.0"}
+
"brr" {>= "0.0.6"}
+
"cmdliner" {>= "1.2.0"}
+
"decompress" {>= "1.5.3"}
+
"fpath" {>= "0.7.3"}
+
"lwt" {>= "5.7.0"}
+
"menhir" {>= "20230608"}
+
"ppx_blob" {>= "0.9.0"}
+
"tyxml" {>= "4.6.0"}
+
"result" {>= "1.5"}
+
"odig" {with-test}
+
"base" {with-test & = "v0.16.3"}
+
"alcotest" {with-test}
+
]
+
depopts: [
+
"ancient" {>= "0.9.1"}
+
]
+
build: [
+
["dune" "subst"] {dev}
+
[
+
"dune"
+
"build"
+
"-p"
+
name
+
"-j"
+
jobs
+
"@install"
+
"@sherlodoc/runtest" {with-test}
+
"@doc" {with-doc}
+
]
+
]
+
dev-repo: "git+https://github.com/ocaml/odoc.git"
+
x-maintenance-intent: ["(latest)"]
+
url {
+
src: "https://github.com/ocaml/odoc/releases/download/3.0.0/odoc-3.0.0.tbz"
+
checksum: [
+
"sha256=ce84fa7e0cc5f3e8a54e6adeb10826152798b602057b9e46c5ae7e5d5206812b"
+
"sha512=9febd413450ca2e3824c9ef7e1c9ae8d8094aa72ed71327a69d8d6b42f6f197b3f3f40d674de0d11fa1242ee0df95c693b5d74467d530704e1339f3a523452f6"
+
]
+
}
+
x-commit-hash: "90e679061f68c5e5ee5915e280f63d842f41f300"
+