Skip to content

fix: exclude _dev from Sphinx source scanning to fix CI build#18

Closed
shaloo with Copilot wants to merge 2 commits into
mainfrom
copilot/fix-failing-github-actions-job
Closed

fix: exclude _dev from Sphinx source scanning to fix CI build#18
shaloo with Copilot wants to merge 2 commits into
mainfrom
copilot/fix-failing-github-actions-job

Conversation

Copilot AI commented Jul 1, 2026

Copy link
Copy Markdown
  • Have you updated CHANGELOG.md with relevant non-documentation file changes?
  • Have you updated the documentation for this change?

The CI job "Test on docs directory" was failing because Sphinx scanned docs/_dev/node_modules/ (populated by pa11y-install), generating 1,234 warnings from npm package README files, which caused the build to fail under --fail-on-warning.

Fix: Add _dev to exclude_patterns in docs/conf.py:

exclude_patterns = [
    "doc-cheat-sheet*",
    ".venv*",
    "_dev",        # prevents scanning node_modules READMEs and other tooling artifacts
]

This mirrors the existing .venv* exclusion — both directories are build tooling, not documentation source.

Copilot AI changed the title [WIP] Fix failing GitHub Actions job for Sphinx stack fix: exclude _dev from Sphinx source scanning to fix CI build Jul 1, 2026
Copilot finished work on behalf of shaloo July 1, 2026 08:52
Copilot AI requested a review from shaloo July 1, 2026 08:52
@jahn-junior

jahn-junior commented Jul 7, 2026

Copy link
Copy Markdown
Collaborator

I'm working on a fix in canonical/sphinx-stack#610, which will be merged by the end of this pulse. This particular change is pretty low-impact, but in general, let's be careful not to introduce much of a delta between the sphinx-stack and the docs.

@jahn-junior

Copy link
Copy Markdown
Collaborator

Closing this in favor of #23 so we also get the fix for post-pa11y checks (e.g., pa11y -> spelling). It's a subtle gap in our tests because pa11y always runs last.

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.

3 participants