odoc icon indicating copy to clipboard operation
odoc copied to clipboard

UI: missing a means to ignore some files or directories?

Open NicNomadic opened this issue 1 year ago • 2 comments

When running odoc on a repository containing both original and vendored source directories, we don't need to publish the doc for the latter, because this (1) takes a lot of extra time, and (2) raise errors for sources we don't control.

I could not find a way to exclude the vendored directories, neither in odoc itself nor when running odoc from dune.

In the latter case, I tried both listing the to-be-ignored dirs in two different dune stanzas:

  • putting them in vendored-dirs doesn't produce any error, but still builds the doc for them
  • putting them in data_only_dirs raises blocking errors such as Library "octez-internal-libs.irmin" not found

Should one of these solutions work? If not, is there another solution?

NicNomadic avatar Jun 07 '24 14:06 NicNomadic

No current solution as far as I'm aware. It's probably worth creating a feature-request issue in ocaml/dune rather than here as the build rules are in dune.

jonludlam avatar Jun 07 '24 15:06 jonludlam

Well this is related to the problem of generating partial docsets see https://github.com/ocaml/odoc/issues/1120

dbuenzli avatar Jun 07 '24 15:06 dbuenzli