odoc icon indicating copy to clipboard operation
odoc copied to clipboard

Documentation compiler for OCaml and Reason

Results 130 odoc issues
Sort by recently updated
recently updated
newest added

Adding a preamble file as a support-files.tex and define a rule for this in dune file.

Implemented as specified in #578 I should probably add some documentation (and maybe more tests), but it would be better if someone could confirm that this implementation is correct beforehand.

after-2.4

I updated the documentation for some commands and added consistency. Sub commands are grouped and sorted in sections, to show the useful commands first. I also updated some doc strings....

after-2.4

**Todo**: - [x] Remove redundant `h6` level after the last variant of a constructor. Also the spacing between `h6` and items is not neat. ``` ######            type days = ######            ...

after-2.4

correct usage example in `test/xref2/lib/common.cppo.ml`

after-2.4

This is a work in progress attempt to implement testable code examples for odoc. Or to be more precise, the extraction of annotated code blocks from `mli` and `mld` files....

after-2.4

While writing the documentation for a project, it appeared to me that `odoc` was generating a category for the parameters of my functor: ![image](https://github.com/ocaml/odoc/assets/24659882/c60c82d9-cc00-4edc-baaf-d0b047d0d9f9) However, even when trying to add...

It's not possible to reference a package main page, which is not a special concept in Odoc but currently a regular page (https://github.com/ocaml/odoc/issues/1037). Drivers currently change the name of the...

Every pages and modules in a package must have a parent page, which is sometimes generated by the driver. Drivers also want a "package list" page, listing all the packages...

For historical reasons `odoc` theming has been implemented in `odig`. The way it works there is described at the `cli` level in `odig`'s manual [here](https://erratique.ch/software/odig/doc/manual.html#odoc_themes); see also `odig odoc-theme --help`....

not stale
enhancement