Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

dune build @doc doesn't update generated documentation properly #11377

Open
jasonyu1996 opened this issue Jan 24, 2025 · 0 comments
Open

dune build @doc doesn't update generated documentation properly #11377

jasonyu1996 opened this issue Jan 24, 2025 · 0 comments
Labels
odoc Issues and PRs related to documentation generation with odoc

Comments

@jasonyu1996
Copy link

Expected Behavior

I made some changes to the inline docs and reran dune build @doc, expecting it to update the generated documentation.

Actual Behavior

Sometimes it works. Sometimes the files do not get updated. Sometimes it is updated but the unchanged modules disappear from the index page.

Specifications

  • Version of dune (output of dune --version): 3.16.0
  • Version of ocaml (output of ocamlc --version): 5.2.0
  • Operating system (distribution and version): Ubuntu 22.04.5 LTS

Additional information

I tried disabling cache but it didn't help. Here's the output of DUNE_CACHE=disabled dune build @doc --verbose, which doesn't seem to produce much helpful information.

Shared cache: disabled
Shared cache location: /home/.../.cache/dune/db
Workspace root: /home/...
Auto-detected concurrency: 64
Dune context:
 { name = "default"
 ; kind = "default"
 ; profile = Dev
 ; merlin = true
 ; fdo_target_exe = None
 ; build_dir = In_build_dir "default"
 ; instrument_with = []
 }
Actual targets:
- recursive alias @doc

dune clean and then dune build @doc again works.

@maiste maiste added the odoc Issues and PRs related to documentation generation with odoc label Jan 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
odoc Issues and PRs related to documentation generation with odoc
Projects
None yet
Development

No branches or pull requests

2 participants