Skip to content

chore: enable sphinx lint trailing-whitespace and horizontal-tab#14771

Merged
skjnldsv merged 4 commits into
masterfrom
skjnldsv-patch-1
May 6, 2026
Merged

chore: enable sphinx lint trailing-whitespace and horizontal-tab#14771
skjnldsv merged 4 commits into
masterfrom
skjnldsv-patch-1

Conversation

@skjnldsv
Copy link
Copy Markdown
Member

@skjnldsv skjnldsv commented May 6, 2026 •
edited
Loading

Removed specific linting rules to simplify sphinx-lint command.

✅ Checklist

  • I have built the documentation locally and reviewed the output
  • Screenshots are included for visual changes
  • I have not moved or renamed pages (or added a redirect if I did)
  • I have run codespell or similar and addressed any spelling issues

@skjnldsv
chore: enable sphinx lint trailing-whitespace and horizontal-tab
9423a68 
Removed specific linting rules to simplify sphinx-lint command.

Signed-off-by: John Molakvoæ <skjnldsv@users.noreply.github.com>
@skjnldsv skjnldsv self-assigned this May 6, 2026
@skjnldsv skjnldsv added 2. developing github_actions Pull requests that update GitHub Actions code labels May 6, 2026
@skjnldsv
Copy link
Copy Markdown
Member Author

skjnldsv commented May 6, 2026

@copilot, fix the inline github comments matcher
https://github.com/nextcloud/documentation/actions/runs/25423143010/job/74569907067?pr=14771

Copy link
Copy Markdown
Contributor

Copilot AI commented May 6, 2026

@copilot, fix the inline github comments matcher
https://github.com/nextcloud/documentation/actions/runs/25423143010/job/74569907067?pr=14771

Fixed in bb9957a. The problem matcher regex only matched .rst files, but sphinx-lint also checks .py files (like conf.py). Updated the pattern from ^(.+\.rst):(\d+): (.+)$ to ^([^:]+\.(?:rst|py)):(\d+): (.+)$ so violations in both file types generate inline GitHub annotations.

Copilot stopped work on behalf of skjnldsv due to an error May 6, 2026 08:14
The session was cancelled by the user.
@skjnldsv
Copy link
Copy Markdown
Member Author

skjnldsv commented May 6, 2026

@copilot fix linting issues

Base automatically changed from copilot/add-sphinx-lint-to-ci to master May 6, 2026 08:17
Copy link
Copy Markdown
Contributor

Copilot AI commented May 6, 2026

@copilot fix linting issues

Fixed in 5f667b8. Resolved all 4,472 sphinx-lint violations across 190 files — 3,487 horizontal-tab (tabs replaced with 4-space indentation) and 985 trailing-whitespace (trailing spaces stripped). sphinx-lint now reports "No problems found."

@skjnldsv skjnldsv requested a review from miaulalala May 6, 2026 08:23
@skjnldsv
Copy link
Copy Markdown
Member Author

skjnldsv commented May 6, 2026

@copilot fix build
/home/runner/actions-runner/_work/documentation/documentation/admin_manual/configuration_files/primary_storage.rst:175: WARNING: Definition list ends without a blank line; unexpected unindent. [docutils]

Copy link
Copy Markdown
Contributor

Copilot AI commented May 6, 2026

@copilot fix build
`/home/runner/actions-runner/_work/documentation/documentation/admin_manual/configuration_files/primary_storage.rst:175: WARNING: Definition list ends without a blank line; unexpec...

Fixed in 72aebdb. The tab+2space sequence on that line was originally aligned to column 10 (tabstop=8), but expandtabs(4) produced only 6 spaces — breaking the .. note:: directive continuation. Changed the indentation to 10 spaces to match the rest of the note body.

@skjnldsv skjnldsv enabled auto-merge May 6, 2026 08:35
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 6, 2026

📖 Documentation Preview

🔍 Open preview →

📄 188 changed documentation pages

Last updated: Wed, 06 May 2026 08:43:04 GMT

@skjnldsv skjnldsv merged commit 8be9ef4 into master May 6, 2026
25 checks passed
@skjnldsv skjnldsv deleted the skjnldsv-patch-1 branch May 6, 2026 08:43
@skjnldsv skjnldsv mentioned this pull request May 12, 2026
Merged
4 tasks
Copilot AI mentioned this pull request May 12, 2026
Merged
Copilot AI added a commit that referenced this pull request May 12, 2026
@skjnldsv
chore: enable sphinx lint trailing-whitespace and horizontal-tab
73e1812 
Backport of PR #14771 to stable32.

Fixes all trailing-whitespace, horizontal-tab, and missing-final-newline
violations in admin_manual, developer_manual, and user_manual so the
full sphinx-lint check passes without any disabled rules.

Co-authored-by: skjnldsv <14975046+skjnldsv@users.noreply.github.com>
Copilot AI mentioned this pull request May 12, 2026
Merged
skjnldsv added a commit that referenced this pull request May 12, 2026
@skjnldsv
Merge pull request #14817 from nextcloud/copilot/backport-14769-and-1…
084195d 
…4771-to-stable32

[stable32] Backport sphinx-lint CI (#14769) and enable all checks (#14771) to stable32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@miaulalala miaulalala miaulalala approved these changes

@nickvergessen nickvergessen Awaiting requested review from nickvergessen nickvergessen is a code owner

@ChristophWurst ChristophWurst Awaiting requested review from ChristophWurst ChristophWurst is a code owner

@GretaD GretaD Awaiting requested review from GretaD GretaD is a code owner

@kesselb kesselb Awaiting requested review from kesselb kesselb is a code owner

@GVodyanov GVodyanov Awaiting requested review from GVodyanov GVodyanov is a code owner

@hamza221 hamza221 Awaiting requested review from hamza221 hamza221 is a code owner

@SebastianKrupinski SebastianKrupinski Awaiting requested review from SebastianKrupinski SebastianKrupinski is a code owner

Assignees

@skjnldsv skjnldsv

Labels

2. developing 3. to review github_actions Pull requests that update GitHub Actions code manual: admin manual: developer manual: user

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@skjnldsv @miaulalala