Skip to content

doc(docs): explain scoped documentation cache recovery #1667

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.

Sign up for GitHub

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

Merged
SamuelSchlesinger merged 1 commit into from
Oct 30, 2026
Merged

doc(docs): explain scoped documentation cache recovery #1667

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,20 @@ Open `http://localhost:8000` to browse and search. The **API documentation** wor
A manual run on another branch produces an `api-docs` artifact instead; serve it by replacing
the directory argument above with the extracted artifact directory.

If removing a source module leaves `check_docs.py` reporting obsolete modules, rebuild the
generated documentation after any documentation build has stopped:

```bash
lake -d docbuild clean docbuild
lake -d docbuild build Complexity:docs
python3 scripts/check_docs.py
```

The named clean removes only `docbuild/.lake/build`, including HTML, per-module data and the
SQLite database; deleting HTML alone leaves stale data behind. Library and dependency build
outputs, package checkouts and Lake's artifact cache are retained. Documentation for all imported
modules is regenerated, which can take substantial time even with warm library build outputs.

#### Checked guide

The [guide](guide/ComplexityGuide.lean) introduces the library area by area, with Lean examples
Expand Down
Loading