No Docs: macOS-only Packages on OCaml.org

The OCaml.org opam documentation process does not trigger for macOS-only packages, leaving ones like osx-keychain labeled as "⚠️ No Docs".

⚠️ No Docs

I couldn't find a mention of this in the official documentation. In 2022, OCaml.org started serving automatically generated documentation for applicable opam packages, making use of a new ocaml-docs-ci documentation pipeline. Earlier this year, OCaml.org upgraded to odoc 3, accompanied by updates to ocaml-docs-ci for odoc 3 compatibility.

ocaml-docs-ci explicitly targets Linux platforms only. Because osx-keychain declares available: [ os = "macos" ], opam treats it as unavailable on ocaml-docs-ci's Linux workers, filtering it out of the set of packages docs-ci considers buildable before even attempting a build.

I think it's reasonable not to spend money trying to self host Mac hardware, but I do wish there was more warning in the opam documentation.

✅ Yes Docs

I've set up GitHub Pages for osx-keychain, and an action to build the documentation for commits on main. So, documentation for osx-keychain now lives at https://alexleighton.github.io/osx-keychain. It's the best I can do for now — I didn't want to push a new version to opam simply to include a docs link in the metadata.