odoc
odoc copied to clipboard
Documentation compiler for OCaml and Reason
This adds a cheatsheet to the odoc manual. Have a look at the rendered page [here](https://choum.net/panglesd/odoc_cheatsheet/cheatsheet.html). The cheatsheet is rendered by odoc, which is not really focused on rendering cheatsheets,...
Fix #941 and #779.
A break from the 3.0 design! Fixes #907 by allowing references to polymorphic variants when the type is given in the reference and the type's manifest is a polymorphic variant....
Standalone documentation comments currently do not have an id. In search results, the goal was to give them the id of the signature they are in. However, there was a...
This PR is a revival of @dbuenzli's original PR on odoc-parser. Since the parser has been moved to the odoc repo, I think we should continue the discussion here. As...
The MWE is highly suggestive of what's going on: ```ocaml module type S1 = sig type t0 type 'a t := unit val x : t0 t end module type...
In my docsets I have hundreds of long links into the www that break my 80 source columns limit. While I may never get to break those in the future,...
This separates the item extraction from the handling of visibility and of the 'hidden' flag. This should catch the bug fixed by https://github.com/ocaml/odoc/pull/1100
Suppose you have the following file: ```ocaml (* test.ml *) module X = Stdlib module Y = X module Z = struct let x = 1 end module T =...
So, if I have this in a .mli: ```ocaml (** Framework for interoperable effects based concurrency. ℹ️ Picos, i.e. this module, is not intended to be an application level concurrent...