Skip to content

dune build @doc documents private libraries #4799

@tjammer

Description

@tjammer

Expected Behavior

When building documentation (dune build @doc) for a project containing private libraries I expect the documentation to not show the private libs.

Actual Behavior

The documentation shows private libraries:

$ dune build @doc
$ cat _build/default/_doc/_mlds/foo/index.mld 
{0 foo index}
{1 Library foo.bar}
The entry point of this library is the module:
{!module-Foo}.
{1 Library secret}
The entry point of this library is the module:
{!module-Secret}.

Reproduction

  1. Set up private library following until Line 38
  2. Build docs dune build @doc
  3. The documentation shows the private library cat _build/default/_doc/_mlds/foo/index.mld

Specifications

  • Version of dune (output of dune --version): 2.9.0, but 2.8x behaves the same
  • Version of ocaml (output of ocamlc --version) 4.12.0
  • Operating system (distribution and version): openSUSE Tumbleweed

Additional information

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions