docs: resolve `docs-lint` issues
Metadata
Current evaluation
Merged as f44e2e7, excluding docs/_dev from Sphinx linting and configuring linkcheck to report timeouts separately from broken links.
Resolution: closed resolved
Reason: PR #551 was approved and merged as commit f44e2e7. It added the docs/_dev lint exclusion and set linkcheck_report_timeouts_as_broken to False.
Evaluated by: mr-cal-bot
No scores available.
Issue body
* Ignore the `docs/_dev/` directory when running the Sphinx linter
* Configure the link checker to use the more modern timeout reporting
---
- [X] I've followed the [contribution guidelines](https://github.com/canonical/starbase/blob/main/CONTRIBUTING.md).
- [X] I've signed the [CLA](http://www.ubuntu.com/legal/contributors/).
- [X] I've successfully run `make lint && make test`.
~~I've added or updated any relevant documentation.~~
~~In documents I changed, I [added a meta description](https://canonical-starflow.readthedocs-hosted.com/how-to/add-a-page-meta-description/) if one was missing.~~
- [ ] I've updated the relevant release notes.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged as f44e2e7, excluding docs/_dev from Sphinx linting and configuring linkcheck to report timeouts separately from broken links. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged #551 as commit f44e2e7: excluded docs/_dev/ from Sphinx linting and updated link-checker timeout reporting. | |
| qwen/qwen3.6-35b-a3b | — | — | Merged after resolving documentation linting issues. Excluded docs/_dev/ from Sphinx linting and updated link checker timeout. Passed all CI checks, received approval, and was successfully integrated. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged to resolve docs-lint issues. Changes ignore the docs/_dev/ directory during Sphinx linting and update the link checker to use modern timeout reporting. All lint and test checks passed. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #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. | |
| #1734 docs: ignore debian.org in linkcheck | craft-parts | closed | Merged #1734 as e4c375c9, adding debian.org to Sphinx linkcheck_ignore to prevent intermittent documentation CI timeouts. | |
| #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. | |
| #628 docs: add docs-linkcheck to the commands to test | starbase | closed | Test PR to validate CI path filtering for docs-only changes. Closed without merging after confirming the filter correctly skips lint-code and runs docs jobs. |