Skip to content

fix(ci,checks): restore CI matrix generation and support collapsible admonitions (#200) - #202

Open
Jalst wants to merge 2 commits into
PyCQA:mainfrom
Jalst:fix-ci-and-collapsible-admonitions
Open

Jalst wants to merge 2 commits into
PyCQA:mainfrom
Jalst:fix-ci-and-collapsible-admonitions

Conversation

@Jalst

@Jalst Jalst commented Sep 17, 2026

Copy link
Copy Markdown

Summary

This PR addresses two key items for doc8:

  1. Restores the broken CI/CD pipeline:

    • The scheduled runs on main and all incoming PRs were failing in the prepare job during the Docker build of coactions/dynamic-matrix@v4 (missing cc during cffi sync in the trixie-slim base container).
    • Migrates matrix generation to ansible/actions/matrix@v1 (matching the current setup used in sister repositories like ansi2html).
    • Updates the artifact download step in the check job to use standard actions/download-artifact@v4 with pattern: logs-* and merge-multiple: true.
    • Adds uv.lock to .gitignore to prevent dirty working tree reports under git status -s.
  2. Supports :collapsible: option for Sphinx admonitions (Fixes Recognize new 'collapsible' directive for admonitions #200):

    • Ignores :collapsible: under admonition directives (note, warning, tip, caution, important, admonition, attention, danger, error, hint) when running in Sphinx mode.
    • Adds unit tests in TestValidity covering both Sphinx-enabled (ignored) and Sphinx-disabled (flagged as D000) cases.

Validation

  • tox -e py (33 passed, full coverage)
  • tox -e lint (pre-commit: ruff, mypy, pylint, pyupgrade, tox-ini-fmt all passed)
  • tox -e docs (Sphinx build + doc8 self-check passed)
  • tox -e packaging (wheel build, twine check, clean install passed)

…admonitions (PyCQA#200)

- Migrate tox.yml from broken coactions/dynamic-matrix to ansible/actions/matrix@v1
- Fix artifact download merge syntax in CI check job
- Add SPHINX_IGNORES_REGEX pattern for :collapsible: option in admonition directives (fixes PyCQA#200)
- Add unit tests in TestValidity verifying sphinx mode behavior
- Add uv.lock to .gitignore
@Jalst
Jalst requested a review from ssbarnea as a code owner September 17, 2026 19:40
@github-actions github-actions Bot added the fix label Sep 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Recognize new 'collapsible' directive for admonitions

1 participant