Skip to content

Add html_favicon to sphinx config - #30

Open
vandalt wants to merge 3 commits into
snakemake:mainfrom
vandalt:add-favicon
Open

Add html_favicon to sphinx config#30
vandalt wants to merge 3 commits into
snakemake:mainfrom
vandalt:add-favicon

Conversation

@vandalt

@vandalt vandalt commented Mar 17, 2026

Copy link
Copy Markdown

This PR adds the favicon so that tabs will show the snakemake icon, like the main docs.

Also, when building locally, pandas was missing so I added it to pixi.toml. I'm new to pixi so let me know if I should do something differently.

Thanks!

Summary by CodeRabbit

  • New Features

    • Added a custom favicon to the HTML documentation for improved visual branding.
  • Chores

    • Added pandas as a project dependency to support data-handling capabilities.

@coderabbitai

coderabbitai Bot commented Mar 17, 2026

Copy link
Copy Markdown
Contributor

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: ccc53a83-0e7c-43a3-bfcc-a2d5c79d5efe

📥 Commits

Reviewing files that changed from the base of the PR and between 22de4b2 and 7903537.

📒 Files selected for processing (1)
  • pixi.toml
🚧 Files skipped from review as they are similar to previous changes (1)
  • pixi.toml

📝 Walkthrough

Walkthrough

Adds a new project dependency (pandas = ">=2.2,<3") to pixi.toml and sets an HTML favicon (_static/logo-snake.svg) in Sphinx config (source/conf.py).

Changes

Cohort / File(s) Summary
Project config & docs
pixi.toml, source/conf.py
Added pandas = ">=2.2,<3" under [dependencies] in pixi.toml; added html_favicon = "_static/logo-snake.svg" to Sphinx source/conf.py.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Title check ⚠️ Warning The PR title mentions only the favicon configuration change, but the changeset also includes a significant dependency addition (pandas) to pixi.toml, which is not reflected in the title. Update the title to reflect both main changes, for example: 'Add favicon to sphinx config and pin pandas version in pixi.toml'
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
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
📝 Coding Plan
  • Generate coding plan for human review comments

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.

Tip

CodeRabbit can use OpenGrep to find security vulnerabilities and bugs across 17+ programming languages.

OpenGrep is compatible with Semgrep configurations. Add an opengrep.yml or semgrep.yml configuration file to your project to enable OpenGrep analysis.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🧹 Nitpick comments (1)
pixi.toml (1)

35-35: Pin the pandas version for reproducibility.

Pandas appears to be a transitive dependency in this project (it's in pixi.lock but not directly imported in any Python files). While most other dependencies specify version ranges like ">=X.Y.Z,<W", using "*" for pandas could lead to unexpected build failures if a major version introduces breaking changes.

Since you explicitly added pandas to pixi.toml, pinning it to a compatible version range ensures reproducible builds:

♻️ Suggested change
-pandas = "*"
+pandas = ">=2.0.0,<3"
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@pixi.toml` at line 35, Update the pandas dependency entry in pixi.toml (the
pandas = "*" line) to pin a safe, reproducible version range instead of "*";
choose a compatible constraint like a specific minor version or a bounded range
(for example ">=1.5.0,<2.0.0") and replace the wildcard so builds are
reproducible and resilient to breaking upstream changes.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@pixi.toml`:
- Line 35: Update the pandas dependency entry in pixi.toml (the pandas = "*"
line) to pin a safe, reproducible version range instead of "*"; choose a
compatible constraint like a specific minor version or a bounded range (for
example ">=1.5.0,<2.0.0") and replace the wildcard so builds are reproducible
and resilient to breaking upstream changes.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: c6b89b93-3f36-47a7-a2ef-ca9612d0bf1c

📥 Commits

Reviewing files that changed from the base of the PR and between d2c11a2 and 22de4b2.

⛔ Files ignored due to path filters (1)
  • pixi.lock is excluded by !**/*.lock
📒 Files selected for processing (2)
  • pixi.toml
  • source/conf.py

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.

1 participant