docs: resolve local build errors
Metadata
Current evaluation
Merged PR #2280 (a60e7229) fixed local docs builds by excluding the affected integrations and JLink plugin pages from Sphinx processing.
Resolution: closed resolved
Reason: PR #2280 was approved and merged as commit a60e7229. Its two-line change adds the failing documentation files to Sphinx's exclude_patterns, resolving the warnings treated as errors.
Evaluated by: mr-cal-bot
No scores available.
Issue body
Local documentation builds currently fail due to the following warnings:
```bash
Warning, treated as error:
/home/ecoldi/Projects/Canonical/charmcraft/docs/reuse/reference/extensions/integrations.rst:125:Undefined substitution referenced: "juju_integrate_postgresql".
make: *** [common.mk:224: docs] Error 2
```
```bash
Warning, treated as error:
/home/ecoldi/Projects/Canonical/charmcraft/docs/common/craft-parts/reference/plugins/jlink_plugin.rst:document isn't included in any toctree
make: *** [common.mk:224: docs] Error 2
```
This absolute behemoth of a PR resolves this issue by adding the guilty files to the `exclude_patterns` list.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged PR #2280 (a60e7229) fixed local docs builds by excluding the affected integrations and JLink plugin pages from Sphinx processing. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged PR #2280 (commit a60e7229) fixed local documentation build errors by excluding the affected integrations and JLink plugin pages from Sphinx processing. | |
| qwen/qwen3.6-35b-a3b | — | — | Merged. Resolved local documentation build failures by adding files causing undefined substitution and toctree warnings to the exclude_patterns list. Approved by two reviewers and passed CI. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged a fix for local documentation build failures caused by warnings treated as errors. Problematic files were added to the exclude_patterns list to resolve undefined substitution and toctree inclusion issues. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #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. | |
| #347 Cleanup warning when building docs | craft-parts | closed | Resolved by merged PR #609 (commit a72d1f26), which cleaned up Sphinx warnings and made documentation builds fail on warnings with -W. | |
| #209 docs: use canonical-sphinx | starbase | merged | Merged PR #209 (commit cd48e13) migrated the documentation build from legacy Sphinx configuration to canonical-sphinx. | |
| #512 docs: linting builds the docs twice | starbase | closed | Fixed by merged PR #513, which changed docs-lint to depend on docs-install instead of docs, eliminating the duplicate documentation build. |