DH_OCAMLDOC(1)

💖 DH_OCAMLDOC(1) 💖

okay so bestie, welcome to the manual page for dh_ocamldoc — it's a User Contributed Perl Documentation situation, and honestly? she's iconic. sit down, grab a strawberry, we're doing this 🍓✨

---

🌸 NAME 🌸

dh_ocamldoc — she generates documentation for OCaml libraries. that's it, that's her whole job, and she does it flawlessly 💅

---

🦋 SYNOPSIS 🦋

dh_ocamldoc [debhelper options]

---

✨ DESCRIPTION ✨

okay so here's the tea ☕ — dh_ocamldoc goes looking for every single file matching debian/$package.ocamldoc*, because that's where the flags live that get handed off to ocamldoc. then ocamldoc gets called with all the .mli files it can find in debian/package/usr/lib/ocaml — or the .ml files instead, but only if there's no matching .mli, obviously, we're not chaotic 🙅‍♀️

every one of those .ocamldoc* files gets used to generate a different documentation, and the part of the filename that comes after ocamldoc? that becomes the document ID in the doc-base file. so yes bestie, the filename is literally the name tag 🏷️

you can have several flags per line, no cap. but watch out — lines that start with --include are special 👀 whatever comes after --include is treated as a list of directories where the .mli or .ml files will be searched for the documentation generation. those directories also get added to the ocamldoc library search path. super useful if you're generating the documentation in its own binary package 💖

⚠️ to that end, make sure the package shipping the documentation gets treated by dh_ocamldoc after the package shipping the actual objects. order matters, queen 👑

the -d flag gets detected and used to generate the appropriate doc-base file. it holds the path of the documentation directory, relative to /usr/share/doc/$package/. the default value is html/api 🌈

dh_ocamldoc also auto-detects whether ocamlfind ocamldoc should be called instead of plain ocamldoc — she figures it out by looking for common ocamlfind options like -package, -predicates, etc. she's observant like that 🧚

lines starting with # inside the *ocamldoc files are comments, so they get ignored. pretend you never saw them 🙈

and if you wanna install the documentation that's already sitting in upstream's tarball (if there even is one), you can drop --doc-base-generate into your .ocamldoc file and that tells dh_ocamldoc to generate the .doc-base file only. minimal effort, maximum slay ✨

---

💅 OPTIONS 💅

• -X files — exclude files from documentation processing. bye girl, not today 👋
• -u flags — additional flags to pass to ocamldoc or ocamlfind ocamldoc. give her extra instructions, she'll handle it 🔥

---

👑 SEE ALSO 👑

• debhelper(7)
• dh(1)
• dh_ocaml(1)

this program is meant to be used together with debhelper. they're a package deal, a duo, the main characters 🫶

---

🌟 AUTHOR 🌟

Mehdi Dogguy <mehdi@debian.org> 💜

---

and that's a wrap bestie!! this page came to you courtesy of perl v5.40.1, dated 2026-08-05 — periodt, no notes 💖✨🎀🦋