Add docs build to CI and GitHub Pages deploy

[gmr]

Summary

• Add docs job to testing.yaml that runs mkdocs build --strict on PRs and pushes
• Remove paths-ignore from testing workflow so docs-only PRs still get CI
• Add docs.yaml workflow to deploy docs to GitHub Pages on push to main (when docs/, mkdocs.yml, or rejected/ change), on release, or via manual dispatch

Test plan

• CI runs docs build on this PR
• All test matrix jobs still pass
• After merge, docs.yaml triggers and deploys to GH Pages

🤖 Generated with Claude Code

Summary by CodeRabbit

• Chores
  • Added automated documentation publishing to GitHub Pages on main branch updates.
  • Integrated documentation validation checks into the continuous integration pipeline.

[coderabbitai]

📝 Walkthrough

Walkthrough

The PR introduces automated documentation deployment via GitHub Actions. A new docs.yaml workflow builds and deploys documentation to GitHub Pages on pushes to main and releases. The testing.yaml workflow is updated to remove path-based exclusions and add a dedicated documentation build verification step.

Changes

Cohort / File(s)	Summary
GitHub Actions Workflows .github/workflows/docs.yaml, .github/workflows/testing.yaml	Added new docs.yaml workflow for building and deploying documentation to GitHub Pages with build and deploy jobs. Updated testing.yaml to remove path-based paths-ignore filters and add a documentation build verification step using uv and MkDocs.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

🐰 Hop, hop, the docs now deploy so fine,
With GitHub Pages, they'll always align,
Each push to main makes the pipeline dance,
Building and shipping docs at a glance! 📚✨

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The PR title directly and clearly summarizes the two main changes: adding a docs build job to the CI workflow and setting up GitHub Pages deployment via a new workflow.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch feature/docs-ci

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

🧹 Nitpick comments (1)

.github/workflows/testing.yaml (1)

2-6: Consider path-based job filtering if CI time becomes a concern.

Removing paths-ignore means docs-only changes now run the full test matrix across Python 3.11–3.14. This is a valid choice for ensuring comprehensive validation, but if CI latency becomes problematic, you could add path-based conditions at the job level:

test:
  if: |
    github.event_name == 'pull_request' ||
    contains(github.event.head_commit.modified, 'rejected/') ||
    contains(github.event.head_commit.modified, 'tests/')

Or use dorny/paths-filter for more granular control. This is entirely optional for now.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In @.github/workflows/testing.yaml around lines 2 - 6, The workflow currently
triggers on pull_request and push (under the on: pull_request / push keys) and
no longer uses paths-ignore, so if CI time becomes a concern add path-based
filtering at the job level (e.g., update the test job named "test" to include an
if: condition that checks github.event_name and modified paths or integrate the
dorny/paths-filter action) to skip running the full matrix for docs-only
changes; modify the "test" job's definition to include either an if clause
referencing github.event.head_commit.modified or wire in the dorny/paths-filter
step before the matrix to gate execution.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In @.github/workflows/testing.yaml:
- Around line 2-6: The workflow currently triggers on pull_request and push
(under the on: pull_request / push keys) and no longer uses paths-ignore, so if
CI time becomes a concern add path-based filtering at the job level (e.g.,
update the test job named "test" to include an if: condition that checks
github.event_name and modified paths or integrate the dorny/paths-filter action)
to skip running the full matrix for docs-only changes; modify the "test" job's
definition to include either an if clause referencing
github.event.head_commit.modified or wire in the dorny/paths-filter step before
the matrix to gate execution.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: fcfb1536-b2f3-42ba-bf77-1b5ef2a01d13

📥 Commits

Reviewing files that changed from the base of the PR and between 217013b and a7a16f4.

📒 Files selected for processing (2)

• .github/workflows/docs.yaml
• .github/workflows/testing.yaml