Skip to content

refactor: resolve CSS Sonar findings without visual changes - #50

Merged
ReenigneArcher merged 1 commit into
masterfrom
refactor/css/sonar-fixes
Oct 16, 2026
Merged

ReenigneArcher merged 1 commit into
masterfrom
refactor/css/sonar-fixes

Conversation

@ReenigneArcher

@ReenigneArcher ReenigneArcher commented Oct 16, 2026 •

Copy link
Copy Markdown
Member

Description

Resolve all 165 active Sonar findings (css:S9423) in the shared stylesheet while preserving the rendered theme. Replace priority annotations with scoped selectors, retain native table alignment and admonition shapes, and let Dockle's responsive CSS own Doxygen panel dimensions and its page-outline grid column.

Screenshot

No intended visual changes. Before/after screenshots and computed styles match across Sphinx (Markdown and reStructuredText), Doxygen, MkDocs, JSDoc, and rustdoc in light/dark modes and desktop/tablet/mobile widths. Screenshot comparisons use Pixelmatch's 0.1 threshold to ignore rasterization noise.

Issues Fixed or Closed

  • Resolve the complete master Sonar baseline: 165 findings, one rule (css:S9423), one affected stylesheet.

Roadmap Issues

Testing

  • Python suite: 123 passed, 14 subtests passed, 5 Linux-only Read the Docs tests skipped on Windows.
  • JavaScript suite: 14 passed; the Doxygen settings/layout runtime has 100% statement and branch coverage.
  • ESLint and git diff --check passed.
  • Strict documentation build passed for all five frameworks and the root Sphinx documentation.
  • 60 normal page/viewport/color combinations and 82 interaction screenshots passed (142 comparisons total), with matching computed styles. Doxygen was also exercised through live resizes at the 800/801 and 1499/1500 breakpoints.
  • Added regression coverage for clearing only conflicting inline panel dimensions, preserving unrelated styles, updating the outline grid, and handling repeated observer delivery/missing panels. Updated stylesheet assertions and prohibit priority annotations in the shared CSS.
  • Sonar PR analysis completed on 47fa550ddc9fca13912b581671ed9dc10af139b0: quality gate OK, 0 active PR findings. The 165 baseline declarations are removed; master will be reanalyzed after merge.

Type of Change

  • feat: New feature (non-breaking change which adds functionality)
  • fix: Bug fix (non-breaking change which fixes an issue)
  • docs: Documentation only changes
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semicolons, etc.)
  • refactor: Code change that neither fixes a bug nor adds a feature
  • perf: Code change that improves performance
  • test: Adding missing tests or correcting existing tests
  • build: Changes that affect the build system or external dependencies
  • ci: Changes to CI configuration files and scripts
  • chore: Other changes that don't modify src or test files
  • revert: Reverts a previous commit
  • BREAKING CHANGE: Introduces a breaking change (can be combined with any type above)

Checklist

  • Code follows the style guidelines of this project
  • Code has been self-reviewed
  • Code has been commented, particularly in hard-to-understand areas
  • Code docstring/documentation-blocks for new or existing methods/components have been added or updated
  • Tests have been added or updated for new or modified functionality, including regression tests for bug fixes

AI Usage

See our AI usage policy.

  • AI tools were used while preparing this PR

@sonarqubecloud

Copy link
Copy Markdown

@codecov

codecov Bot commented Oct 16, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.17%. Comparing base (e486925) to head (47fa550).
✅ All tests successful. No failed tests found.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##           master      #50      +/-   ##
==========================================
+ Coverage   93.06%   93.17%   +0.11%     
==========================================
  Files          12       12              
  Lines        1960     1993      +33     
  Branches       62       69       +7     
==========================================
+ Hits         1824     1857      +33     
  Misses        136      136              
Flag Coverage Δ
Linux-python-3.11 92.74% <ø> (ø)
Linux-python-3.14 92.74% <ø> (ø)
Windows-python-3.11 92.90% <ø> (ø)
Windows-python-3.14 92.90% <ø> (ø)
macOS-python-3.11 92.74% <ø> (ø)
macOS-python-3.14 92.74% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
...le/sphinx/themes/dockle/static/doxygen-settings.js 100.00% <100.00%> (ø)

Continue to review full report in Codecov by Harness.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e486925...47fa550. Read the comment docs.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@ReenigneArcher
ReenigneArcher merged commit 613c17c into master Oct 16, 2026
32 checks passed
@ReenigneArcher
ReenigneArcher deleted the refactor/css/sonar-fixes branch October 16, 2026 01:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant