ocaml / ocaml/dune

`dune build @doc` does not rebuild pages

Open
#7,720 16 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

odoc
Dominant language
OCaml
Stars
1.9k
Forks
500
Avg merge
15h 21m
Merged PRs (30d)
277

Description

Expected Behavior

I have modified some mli interface and I expect to see the changes after running dune build @doc.

Actual Behavior

After running dune build @doc, I see nothing (the command exit code is $0$). Worst than that, if I undo my modifications (the git staged area is clear), the index pages is produced, but the link to individual modules' documentation are dangling pointers. The first time I ran dune build @doc they were not. I also tried dune build @doc --force, but it has no effect.

I use dune cache. I have tried to deactivate it (using --cache=disabled CLI option), but it does not change anything.

I also tried to remove the _build directory but the problem still occur.

Reproduction

I am not sure how to reproduce this.

Specifications

  • Version of dune (output of dune --version): 3.7.0
  • Version of ocaml (output of ocamlc --version): The OCaml toplevel, version 4.14.1
  • Operating system (distribution and version): Linux Debian Bullseye

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing the issue with dune build @doc using the reported Dune 3.7.0 and OCaml 4.14.1 setup, then compare behavior with and without dune cache and with --force or --cache=disabled. Done means modifying an .mli causes the documentation pages to rebuild and leaves valid links to individual module documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
ocaml
Domain
build-system
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Needs clarification
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.