Skip to content

Fix docs publishing#201

Open
d33bs wants to merge 4 commits intocytomining:mainfrom
d33bs:fix-publish
Open

Fix docs publishing#201
d33bs wants to merge 4 commits intocytomining:mainfrom
d33bs:fix-publish

Conversation

@d33bs
Copy link
Member

@d33bs d33bs commented Mar 11, 2026

Description

This PR fixes docs publishing by using a group reference (this was incorrectly implemented before using with).

What kind of change(s) are included?

  • Documentation (changes docs or other related content)
  • Bug fix (fixes an issue).
  • Enhancement (adds functionality).
  • Breaking change (these changes would cause existing functionality to not work as expected).

Checklist

Please ensure that all boxes are checked before indicating that this pull request is ready for review.

  • I have read and followed the CONTRIBUTING.md guidelines.
  • I have searched for existing content to ensure this is not a duplicate.
  • I have performed a self-review of these additions (including spelling, grammar, and related).
  • These changes pass all pre-commit checks.
  • I have added comments to my code to help provide understanding
  • I have added a test which covers the code changes found within this PR
  • I have deleted all non-relevant text in this pull request template.

Summary by CodeRabbit

  • Chores
    • Adjusted documentation build configuration to change how docs are grouped during builds.
    • Bumped a development formatting hook to a newer version to keep tooling up to date.
    • Cleaned up minor whitespace in project metadata to tidy configuration files.

@coderabbitai
Copy link

coderabbitai bot commented Mar 11, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: aec903a1-47c6-45b5-a6c9-f5ad89764e9c

📥 Commits

Reviewing files that changed from the base of the PR and between a4888d6 and ce06fd6.

📒 Files selected for processing (1)
  • pyproject.toml
💤 Files with no reviewable changes (1)
  • pyproject.toml

📝 Walkthrough

Walkthrough

The CI docs publish workflow replaces --with docs with --group docs for the uv Sphinx build; the pyproject-fmt pre-commit hook rev was updated from v2.16.2 to v2.18.1. A lone blank line was removed from pyproject.toml.

Changes

Cohort / File(s) Summary
CI Workflow
/.github/workflows/publish-docs.yml
Replaced --with docs with --group docs in the uv Sphinx build command.
Pre-commit hooks
/.pre-commit-config.yaml
Bumped pyproject-fmt hook rev from v2.16.2 to v2.18.1.
Project config
pyproject.toml
Removed an empty blank line before the [tool.bandit] section; no config changes.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 I nudged a flag at morning light,
and nudged a hook to run more bright,
a blank line hopped away with glee,
docs build smoother — come see, come see! 🥕

🚥 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 title clearly identifies the main fix: changing the uv run command from --with docs to --group docs in the publish-docs.yml workflow to resolve the documentation publishing issue.
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
  • Post copyable unit tests in a comment

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

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

@d33bs d33bs marked this pull request as ready for review March 11, 2026 16:19
@d33bs d33bs requested a review from jenna-tomkinson as a code owner March 11, 2026 16:19
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
.pre-commit-config.yaml (1)

18-18: Keep the formatter bump separate or test it thoroughly in isolation.

The pyproject-fmt upgrade from v2.16.2 to v2.18.1 introduces formatting behavior changes unrelated to the docs publishing fix:

  • v2.17.0: Adds shared config file auto-discovery (pyproject-fmt.toml walking up parent directories), which can change output if such a file exists.
  • v2.18.0: Includes TOML normalization changes—stripping redundant quotes from keys and normalizing inline-table key ordering—that can affect generated diffs.

These changes could cause CI failures or unexpected formatting diffs when applied. Since this bump is orthogonal to the stated bug fix, either keep it in a separate commit/PR for isolated testing or verify the formatting impact on this repo's pyproject.toml before merging.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In @.pre-commit-config.yaml at line 18, The pre-commit upgrade to pyproject-fmt
(the rev "v2.18.1" entry in .pre-commit-config.yaml) is orthogonal to the docs
publishing fix and can change formatting behavior; either move this rev bump
into its own commit/PR for isolated testing or revert it here and separately
validate effects against this repo’s pyproject.toml (look for the pyproject-fmt
hook entry and the rev string "v2.18.1") to ensure no unexpected formatting
diffs before merging.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In @.pre-commit-config.yaml:
- Line 18: The pre-commit upgrade to pyproject-fmt (the rev "v2.18.1" entry in
.pre-commit-config.yaml) is orthogonal to the docs publishing fix and can change
formatting behavior; either move this rev bump into its own commit/PR for
isolated testing or revert it here and separately validate effects against this
repo’s pyproject.toml (look for the pyproject-fmt hook entry and the rev string
"v2.18.1") to ensure no unexpected formatting diffs before merging.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 3bb17872-53a5-4e7f-8400-27ef32983608

📥 Commits

Reviewing files that changed from the base of the PR and between be29c56 and a4888d6.

📒 Files selected for processing (1)
  • .pre-commit-config.yaml

Copy link
Member

@jenna-tomkinson jenna-tomkinson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! I am not familiar with the flags for UV, but if this is the fix, then looks good!

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.

2 participants