Skip to content

Add project logo to README and documentation#650

Merged
laughingman7743 merged 5 commits intomasterfrom
feature/add-project-logo
Feb 8, 2026
Merged

Add project logo to README and documentation#650
laughingman7743 merged 5 commits intomasterfrom
feature/add-project-logo

Conversation

@laughingman7743
Copy link
Member

Summary

  • Add a cute owl mascot logo representing PyAthena's identity (Athena's owl + Python snake + Greek helmet)
  • Display the logo in the README and Sphinx documentation (index page + sidebar)
  • Add attribution for the logo generation tool (Nano-Banana Pro / Gemini 3 Pro Image)

Changes

  • docs/_static/logo.png: New logo image file
  • README.rst: Add logo at the top and attribution in a new "Logo" section
  • docs/index.rst: Add logo at the top of the documentation index page
  • docs/conf.py: Set html_logo for the Furo theme sidebar

Test plan

  • Verify the logo renders correctly on GitHub README
  • Build docs locally with make docs and verify logo appears in sidebar and index page
  • Confirm logo displays at appropriate size on both desktop and mobile

🤖 Generated with Claude Code

@laughingman7743 laughingman7743 force-pushed the feature/add-project-logo branch 4 times, most recently from c75670e to 7442d91 Compare February 8, 2026 05:32
- Convert README.rst to README.md with equivalent content
- Add project icon and logo images to docs/_static/
- Display centered icon with badge links in README header
- Add sidebar logo CSS for Sphinx documentation
- Update pyproject.toml references from README.rst to README.md

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@laughingman7743 laughingman7743 force-pushed the feature/add-project-logo branch from 8a52dcf to cea32da Compare February 8, 2026 06:03
- Add sphinxext-opengraph dependency
- Configure OGP with site URL, logo_square.png image, and metadata
- Enables rich previews when sharing documentation links on Slack, Twitter, etc.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@laughingman7743 laughingman7743 force-pushed the feature/add-project-logo branch from 6760589 to 541ec12 Compare February 8, 2026 06:09
laughingman7743 and others added 2 commits February 8, 2026 15:52
- Add ogp.png (transparent), ogp_white.png, ogp_dark.png (1280x640)
- Use ogp_white.png for og:image (most compatible across platforms)

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Content was top-aligned with 0px top / 30px bottom margin.
Now centered with 15px on each side.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@laughingman7743 laughingman7743 merged commit e2938c7 into master Feb 8, 2026
5 checks passed
@laughingman7743 laughingman7743 deleted the feature/add-project-logo branch February 8, 2026 07:48
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