leanprover-community / leanprover-community/mathlib4

Building HTML documentation instructions fails on clean clone

Open
#15,369 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Lean
Stars
4.2k
Forks
1.7k
PR merge metrics
No merged PRs in 30d

Description

When cloning a fresh version of mathlib (https://github.com/leanprover-community/mathlib4/commit/9610549d4c892f252d1bb1a96bdde7bbedb7589b specifially) and running the instructions for building the HTML documentation fails with:

❯ lake -R -Kdoc=on update doc-gen4
  lake build Mathlib:docs
info: batteries: cloning https://github.com/leanprover-community/batteries to '././.lake/packages/batteries'
info: Qq: cloning https://github.com/leanprover-community/quote4 to '././.lake/packages/Qq'
info: aesop: cloning https://github.com/leanprover-community/aesop to '././.lake/packages/aesop'
info: proofwidgets: cloning https://github.com/leanprover-community/ProofWidgets4 to '././.lake/packages/proofwidgets'
info: importGraph: cloning https://github.com/leanprover-community/import-graph to '././.lake/packages/importGraph'
info: Cli: cloning https://github.com/leanprover/lean4-cli to '././.lake/packages/Cli'
info: mathlib: running post-update hooks
error: unknown library facet `docs`

System information:

❯ elan --version
elan 3.1.1 (71ddc6633 2024-02-22)

❯ lean --version
Lean (version 4.10.0, arm64-apple-darwin23.5.0, commit c375e19f6b65, Release)

❯ lake --version
Lake version 5.0.0-c375e19 (Lean version 4.10.0)

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 documented HTML build command on the referenced clean commit: lake -R -Kdoc=on update doc-gen4. Inspect how the documentation build exposes the docs library facet and verify the command succeeds after dependencies are fetched; done means the clean-clone documentation build completes without the unknown-facet error.

Written by the indexing model from the issue text.

Assessment

Domain
build-system, documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.