odoc
odoc copied to clipboard
ocaml
Documentation compiler for OCaml and Reason
Code such as: ```ocaml type sp = | Blank (** {[ ]} *) ``` leads to a warning such as ``` Warning: Invalid documentation comment: File "lib/Fmt.mli", line 23, characters...
ppx_js_style is the Jane Street style checking ppx. One of the things it checks is that documentation comments have valid syntax using the documentation comment parser from the old version...
When cross referencing a section from a different page without a specified text for the link, the label will not be expanded into the corresponding section's title. For example, if...
Running `dune build @doc` on current Irmin main (`0619381cd2910bf0b0c25ec03d8ddcdd81bba419`) causes Odoc to fail with the following internal error: ``` odoc: internal error, uncaught exception: Not_found Raised at Stdlib__map.Make.find in file...
Running `dune build @doc` on https://github.com/CraigFe/alcotest/commit/6d8bd626435b43f2c93924bbf40fbfec3cde9f46 causes Odoc to fail with the following internal error: ``` odoc: internal error, uncaught exception: Failure("Not_found: M/3789") Raised at Stdlib.failwith in file "stdlib.ml", line...
In https://github.com/dbuenzli/odig/commit/90f8660f2b386f0707ea4148778bf31cf6d50050 I have implemented a first shot at support for documentation assets (used by Vg since this commit https://github.com/dbuenzli/vg/commit/e01ae8eb6214725c8aae0a3fd5a001787fc89782) . I do however think that `odig` is the wrong...
When you develop your package locally you'd like to be able to generate its documentation in its say `_build` directory but also to check the accuracy of external links against...
`ocamldoc` was fine with them. Currently this also drops the reference text which is annoying. I don't exactly see what's the problem with having xrefs in headings. Example: https://b0-system.github.io/odig/doc/fpath/Fpath/index.html#ex_append https://erratique.ch/software/fpath/doc/Fpath.html#ex_append...
With the following: ``` > cat a.mli (**/**) val ha : string -> string (**/**) val bla : string -> string (** [bla] is bla. *) ``` We get an...
Currently the `mld` filename is used as a title for the generated HTML document. This is not ideal because the name is an "artefacts of the underlying producing technology" and...
