← Back to issue list

fix(common.mk): skip frivolous link checks in lint-docs

View original Github issue

Metadata

Project
starbase
Number
#333
Type
pull request
State
merged
Author
medubelko
Labels
Created
Updated
Closed

Current evaluation

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.

Suggested action:

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
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 issues

Issue Project State Summary Similarity
#321 docs: remove fragment from link for linting rockcraft merged Merged a documentation update removing a link fragment to resolve linting errors. Approved by two reviewers, passed CI checks, and merged.
74%
#324 fix(common.mk): docs ignores starbase merged Merged a single-line update to common.mk that corrects documentation ignore patterns. The change received approval from two reviewers, passed CI validation, and implements fixes referenced in PR #2096.
73%
#551 docs: resolve `docs-lint` issues starbase merged 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.
71%
#493 fix(build): false lint errors starbase merged Merged a fix for false lint errors by ignoring the .sphinx directory and splitting sphinx-lint arguments. All CI checks passed and reviewers approved the changes.
71%
#513 build(docs): fix double build with docs-lint starbase merged Merged a one-line fix resolving a double build issue during docs-lint by correcting a mistaken assumption about Sphinx's linter requirements. Approved by two reviewers, passed CI, and closed issue #512.
71%