← Back to issue list

docs: linting builds the docs twice

View original Github issue

Metadata

Project
starbase
Number
#512
Type
issue
State
closed
Author
medubelko
Labels
Status: Triaged Type: Bug
Created
Updated
Closed

Current evaluation

Fixed by merged PR #513, which changed docs-lint to depend on docs-install instead of docs, eliminating the duplicate documentation build.

Resolution: closed resolved

Reason: PR #513 was merged as commit 1107517 and updated the docs-lint dependency from docs to docs-install.

Evaluated by: mr-cal-bot

No scores available.

Issue body

## Situation Due to an oversight, the docs builds one extra time during linting. It was mistakenly believed that sphinx-lint needed a build. ## Request Offending line: https://github.com/canonical/starbase/blob/39eefe06225b16377ccaea711dc12b46f18d2c82/common.mk#L331 Change to: ```diff -docs-lint: docs ##- Lint the documentation +docs-lint: docs-install ##- Lint the documentation ```

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Fixed by merged PR #513, which changed docs-lint to depend on docs-install instead of docs, eliminating the duplicate documentation build.
stealth/space-bunny-alpha — closed stale Closed with no documented resolution in the supplied record; the only comment is an automated Jira-sync notice for CRAFT-5075.
qwen/qwen3.6-35b-a3b — — Closed. Implemented the suggested fix by changing the docs-lint target dependency from docs to docs-install in common.mk, preventing redundant documentation builds.
qwen/qwen3.6-35b-a3b — — Resolved duplicate documentation builds during linting by updating the Makefile dependency from docs to docs-install, eliminating the redundant build step.
qwen/qwen3.6-35b-a3b — — Fixed by changing the Makefile lint target dependency from docs to docs-install, preventing duplicate documentation builds during linting.
qwen3.6-35b-a3b-mtp-q6 — — Resolved by updating the Makefile lint target dependency from docs to docs-install, preventing redundant documentation builds during linting.

Update history

No update history recorded yet.

Related work

  • Likely Fixed By: canonical/starbase#513 (confidence 100%)

    Merged fix for the redundant docs build reported in #512.

Related issues

Issue Project State Summary Similarity
#513 build(docs): fix double build with docs-lint starbase merged Merged #513 in commit 1107517, changing docs-lint to install dependencies without a full docs build and fixing #512's redundant double build.
85%
#525 build: fix docs-install target starbase merged Merged PR #525 as commit b434201, fixing docs-install so make lint keeps the correct development dependencies installed throughout linting.
80%
#508 fix: quieter docs-lint in CI starbase merged Merged #508, grouping docs-lint setup and execution in CI log groups to reduce verbosity; all reported checks passed.
72%
#2091 Docs: uv-based lint command checks artifact directory charmcraft closed Fixed by ignoring generated docs/_build files in sphinx-lint via merged PR canonical/charmcraft#2096 (commit 5e2adcb0).
71%
#6133 build: fix docs-install target snapcraft merged Merged PR #6133 as commit f6f0bd918, fixing the docs-install Make target that was breaking documentation builds after dependency setup.
71%
#551 docs: resolve `docs-lint` issues starbase merged Merged as f44e2e7, excluding docs/_dev from Sphinx linting and configuring linkcheck to report timeouts separately from broken links.
71%
#2280 docs: resolve local build errors charmcraft merged Merged PR #2280 (a60e7229) fixed local docs builds by excluding the affected integrations and JLink plugin pages from Sphinx processing.
71%
#54 fix(docs): make readthedocs build correctly craft-platforms merged Merged PR #54 via commit 16406ff, correcting the Read the Docs configuration so the documentation builds successfully.
70%
#5832 build(docs): remove line length check from linter snapcraft merged Merged PR #5832 in commit a634d1f08, removing the documentation line-length check from the linter in a one-line configuration change.
70%
#453 build(docs): remove line length check from linter starbase merged Merged PR #453 removed the documentation line-length check from the linter in commit ec0cf32.
70%