odoc
odoc copied to clipboard
ocaml
Documentation compiler for OCaml and Reason
#913 has vendored a lot of fonts. This is great! However, there is still room for improvement: [local font fallback](https://drafts.csswg.org/css-fonts/#local-font-fallback). This will prefer the font on the system rather than...
Rather than putting the item between `(**/**)` comments - it's easier for ppxes.
e.g. [@param] tags on instance variables are rendered. See https://ocaml.org/releases/4.12/htmlman/ocamldoc.html#ss:ocamldoc-syntax for a more detailed description of the expected behaviour.
odoc version: 2.2.0. Originally reported in: https://github.com/ocaml-doc/voodoo/issues/61. > From this build https://docs.ci.ocaml.org/job/2023-04-26/140729-voodoo-do-7c9b58: ``` odoc: internal error, uncaught exception: File "src/xref2/tools.ml", line 1600, characters 9-15: Assertion failed Raised at Odoc_xref2__Tools.assert_not_functor in...
dune configurator [has this code](https://github.com/ocaml/dune/blob/main/otherlibs/configurator/src/v1.mli): ```ocaml module V1 : sig type t module Pkg_config : sig type configurator = t type t (** Search pkg-config in the PATH. Returns [None]...
I have a .mld file which contains: ``` {0 Sparse-file package} {1 Previous documents} @see "Implementing GC for Irmin", describes the basic structure of a pack file, what a sparse...
For the moment we allow users to annotate module definitions with `(** @canonical Some.Path *)` but we do not check that `Some.Path` is indeed equivalent to the module being defined.
How useful is it to have special UI support in odoc for anonymous includes? Consider this example: ```ocaml (* x.mli *) include module type of struct include Pervasives end ```...
Sometimes people have small sub-modules and they would prefer to get something like: ```ocaml module Foo : sig type t val x : t end ``` in their docs instead...
The latex renderer currently creates one latex file by module, and expects the user to provide the latex preamble. Since the minimal preamble is not that small (see https://github.com/ocaml/odoc/blob/master/test/latex/expect/visualizer.tex for...
