odoc
odoc copied to clipboard
ocaml
Documentation compiler for OCaml and Reason
I noticed that the Lwt documentation has doc comments like this: There are straightforward ways to make promises canceled. One could create a promise that {e starts out} canceled, with...
The Lwt documentation has snippets such as: - {{: #3_Quickstart} Quick start} links these concepts to actual functions in Lwt – the most fundamental ones. .... {3 Quick start} or...
When `odoc` includes a codeblock (i.e., when the source includes a `{[`-`]}` pair), the comments in that block are rendered as a light shade of grey on a white background....
**What is `odoc`?** 1. **`odoc` is a documentation generator for OCaml** Would it be helpful to compare it to Doxygen for concept? 2. **It reads doc comments from your source...
When writing an ocaml code block in odoc markup that itself contains an odoc code block, the first end of block delimiter is interpreted as closing the encompassing block. For...
The pre/code CSS wrongly assumes the contents is too long, inserts a scroll box, and scrolls so that the first few columns of the contents is invisible (and needs to...
Following the discussion of https://github.com/ocaml/dune/issues/5770, it seems we should invent some pragma directive in (the header of?) an `mld` file that has the same effect of passing the `--open` option...
[This definition](https://ocaml.org/p/async_kernel/v0.15.0/doc/Async_kernel/index.html#val-after) Should look like: ```ocaml val after : Time_ns.Span.t -> unit Deferred.t ``` Where `Time_ns.Span.t` is from `Core` and is defined as: ```ocaml type t = private Int63.t ```...
This issue is for discussing the syntax for including images in odoc. Since the parser has been remerged into this repo, I open it here! ### External and internal images...
The whole experience for writers improved quite a bit over the years. Basically we no longer have to define artificial types we can now write: ``` module M : sig...
