in a recent thread: Suggestions for ocaml documentation
I (and others) proposed to insert the OCaml manual in the
I am now working on the API part of it. Here is a first proposition:
Of course it can be improved, and I’m asking for constructive comments, keeping in mind:
- the design has to integrate well with the current design of
- it has to be consistent with the “tutorial” part of the manual:
On the technical side, finally I didn’t use
odoc because @octachron remarked that it could lead to issues when generating the PDF. Hence I only post-processed the html; but this is rather light, it takes about 2sec for about 380 files in the
libref directory. Once
odoc gets updated, we can think back.
Some precise questions:
- in many pages there is room left on the sidebar, so we could implement a search engine. Would it be useful? Does someone know how to do it?