odoc
odoc copied to clipboard
ocaml
Documentation compiler for OCaml and Reason
Since we eventually want to render the `opam` documentation using `odoc`, `odoc` should render manuals in such a way that the manual pages are discoverable in the UI. This means...
It would be nice to attach an odoc comment to a function parameter rather than having to mention each parameter in the comment for the whole function. Something like: ```ocaml...
```ocaml module X : sig module type T = sig (** {!t} *) end type t end module Y : X.T ``` The reference that's inside `X.T` won't resolve in...
https://caml.inria.fr/pub/docs/manual-ocaml/ocamldoc.html#sss:ocamldoc-html-tags
Currently there is no support for unqualified references to items brought into the scope by an `open`. This was reported by @dbuenzli: https://github.com/ocaml/odoc/issues/585#issuecomment-777599121 For example: ```ocaml module A : sig...
Since the page rendering adds non-user defined headings and the resulting signature is inlined it makes it for a confusing heading structure: https://b0-system.github.io/odig/doc/asetmap/Asetmap/Set/Make/index.html ([`src`](https://github.com/dbuenzli/asetmap/blob/master/src/asetmap.mli)) Here are a few ideas: 1....
I'm sure this is going to be controversial but I'll put it in to see what the mood is. In general `odoc` html rendered specifications are much less readable than...
It would be great to generate ranked search indices of the docs. James Somers at Jane Street wrote a patch that we used to generate a search index for an...
for a set of files like: - m1.ml ```ocaml module Foo = struct type t end ``` - m2.ml ```ocaml module Previous = M1 module Foo = Previous.Foo ``` -...