fix(common.mk): skip frivolous link checks in lint-docs
Metadata
Current evaluation
Merged PR #333 as commit 97abd69, disabling two spurious sphinx-lint checks for literalref output while the upstream extension bug remains unresolved.
Resolution: closed resolved
Reason: PR #333 was merged as commit 97abd69, updating common.mk to skip checks that falsely flag valid literalref formatting. The underlying extension defect is tracked in canonical/canonical-sphinx-extensions#47.
Evaluated by: mr-cal-bot
No scores available.
Issue body
Resolve erroneous link warnings affecting literalref directives. Sphinx-lint will no longer check for spaces before angle brackets (\`\` <>\`\`) or underscores after graves (\`\`_).
The root cause is a bug in our implementation of literalref: https://github.com/canonical/canonical-sphinx-extensions/issues/47
- [x] Have you followed the guidelines for contributing?
- [x] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)?
- [x] Have you successfully run `uv`?
---
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged PR #333 as commit 97abd69, disabling two spurious sphinx-lint checks for literalref output while the upstream extension bug remains unresolved. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged common.mk change disables two erroneous sphinx-lint link checks for literalref output; the underlying extension bug is tracked in canonical/canonical-sphinx-extensions#47. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged starbase#333 to disable sphinx-lint checks causing false link warnings for literalref directives; root cause remains canonical-sphinx-extensions#47. | |
| qwen/qwen3.6-35b-a3b | — | — | Merged a fix to skip erroneous Sphinx-lint link checks in lint-docs. The change disables validation for spaces before angle brackets and underscores after backticks, resolving false warnings from a literalref directive bug. Approved and passed CI. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged a fix to disable specific Sphinx-lint link checks in lint-docs, resolving erroneous warnings for literalref directives. The change works around a bug in canonical-sphinx-extensions. |
Update history
No update history recorded yet.
Related work
-
Caused By:
canonical-sphinx-extensions#47
(confidence 99%)
The PR identifies this literalref implementation bug as the root cause of the erroneous warnings.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #324 fix(common.mk): docs ignores | starbase | merged | Merged PR #324 as commit 9b08557, updating common.mk to ignore docs/_build and prevent generated documentation from triggering style-check failures. | |
| #321 docs: remove fragment from link for linting | rockcraft | merged | Merged PR #321 in commit 21717456, removing a documentation link fragment to satisfy linting. |