docs: resolve local build errors
Metadata
Current evaluation
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.
Suggested action: —
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 |
|---|---|---|---|---|
| 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. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged. Resolved local documentation build failures by adding problematic RST files to the exclude_patterns list, fixing undefined substitution and missing toctree warnings treated as errors. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #1247 docs: exclude 'including local files and remote resources' from build | rockcraft | merged | Merged a single-line documentation update that excludes a file from the build. This prevents a duplicate in the common folder from appearing in site search results. Approved by one reviewer with all CI checks passing. | |
| #2299 docs: fix formatting issues | charmcraft | merged | Merged documentation formatting fixes resolving local build errors. Approved by two reviewers with minimal changes (+3/-1 across two files). Merged despite failing snap-build CI checks. | |
| #1021 docs: prevent transclusion issues | craft-parts | merged | Merged to resolve documentation transclusion issues in downstream applications. Approved by three reviewers, passed CI checks, and modified two files (+12/-15 lines). | |
| #258 docs: update readme and template, fix build error | starbase | merged | Merged after two reviewer approvals and passing CI. Updated README wording, added doc preparation details, and disabled PDF and EPUB generation to resolve build errors. All changes passed tests with 100% coverage. | |
| #383 docs: fail on RTD warnings | starbase | merged | Merged configuration to fail CI builds on ReadTheDocs warnings, resolving a recurring issue where documentation warnings were silently ignored. Approved by two reviewers and passed all checks. | |
| #294 docs: add CONTRIBUTING.md | craft-store | merged | Merged addition of CONTRIBUTING.md documentation. Approved by two reviewers and passed most CI checks. Minor discussions about local integration test instructions were noted but did not block the merge. | |
| #2186 docs: fix build errors | charmcraft | merged | Merged a one-line documentation fix to resolve recent build errors. Approved by two reviewers. Remaining build issues were subsequently addressed in craft-parts pull request 1021. | |
| #1104 docs: update links | craft-parts | merged | Merged after two reviewers approved. Updated documentation to fix broken links. Integrated into the main branch despite some CI test failures. | |
| #1302 docs: rewrite some redirects | craft-parts | merged | Merged documentation rewrite correcting several redirects to resolve recurring lint CI failures. Approved by two reviewers, passed all CI checks, and modified four files with minimal changes. | |
| #354 docs: incorporate tutorial feedback | imagecraft | merged | Merged documentation updates incorporating tutorial feedback. Approved by a reviewer, passed all CI checks, and modified four files. Changes preempt updates in a related pull request. |