ODOC(1)

✨ NAME ✨

okay so bestie, this is the odoc(1) page from the Odoc Manual πŸ’–

odoc β€” documentation generator for OCaml. periodt.


πŸ¦‹ SYNOPSIS πŸ¦‹

odoc COMMAND ...

πŸ› οΈ COMMANDS πŸ› οΈ

okay so these are the commands, bestie, and every single one matters, iykyk πŸ‘‘

  • compile β€” compile a cmti, cmt, cmi or mld file to an odoc file. πŸ’…
  • compile-deps β€” lists the units (plus their digest) that need to be compiled before you can compile this one. The unit itself and its digest also show up in the output. 🧚
  • compile-targets β€” TODO: Fill in. 😭
  • css β€” DEPRECATED: Use `odoc support-files' to copy the CSS file for the default theme. πŸ’€
  • html β€” Generates an html file from an odoc one. ✨
  • html-deps β€” lists the packages which need to be in odoc's load path to process html from the .odoc files in the given directory. πŸ¦‹
  • html-fragment β€” Generates an html fragment file from an mld one. 🌸
  • html-targets β€” TODO: Fill in. πŸ™ˆ
  • support-files β€” Copy the support files (e.g. default theme, JavaScript files) to the output directory. πŸŽ€
  • support-files-targets β€” Lists the names of the files that 'odoc support-files' outputs. πŸ’œ

πŸŽ€ OPTIONS πŸŽ€

  • --help[=FMT] (default=auto) β€” show this help in format FMT. The value FMT must be one of auto, pager, groff or plain. With auto, the format is pager or plain whenever the TERM env var is dumb or undefined. πŸ’…
  • --version β€” show version information. ✨

byeee bestie, that's the whole odoc(1) page from the Odoc Manual, and this version is Odoc 11VERSION11 πŸ«ΆπŸ’œ