Skip to content

docs: add pytest/libiio themed logo and favicon for Sphinx documentation#64

Open
tfcollins wants to merge 1 commit intomasterfrom
tfcollins/add-logos-for-documentation--the-theme-s-140404
Open

docs: add pytest/libiio themed logo and favicon for Sphinx documentation#64
tfcollins wants to merge 1 commit intomasterfrom
tfcollins/add-logos-for-documentation--the-theme-s-140404

Conversation

@tfcollins
Copy link
Copy Markdown
Owner

@tfcollins tfcollins commented Mar 2, 2026

Summary

Adds a custom branded logo and favicon to the Sphinx/Furo documentation,
combining the pytest and libiio visual identities into a cohesive banana
mascot theme.

Changes

New Assets

  • docs/_static/logo-pytest-libiio-banana.svg: Custom SVG logo featuring a
    banana mascot with purple goggles, green pytest checkmarks, circuit board
    traces, and signal waveforms — blending the pytest and libiio project
    aesthetics
  • docs/_static/favicon.svg: 32×32 SVG favicon using the same
    banana+checkmark+goggle motif, with dark-mode support via CSS media queries

Styling

  • docs/_static/custom.css: Constrains the sidebar logo dimensions to a
    maximum width of 120px and height of 100px to ensure consistent rendering
    across viewport sizes

Configuration

  • docs/conf.py: Updates Furo html_theme_options to wire up
    light_logo, dark_logo, html_logo, html_favicon,
    html_static_path, and html_css_files so the new assets are loaded
    automatically by the theme

Impact

The documentation now has a distinct, project-specific visual identity that
reflects both the pytest testing framework and the libiio library. The
favicon improves browser tab recognition, and the SVG format ensures crisp
rendering at all resolutions including HiDPI displays.

Closes https://github.com/tfcollins/tbot/issues/19

Summary by Sourcery

Add custom branded pytest/libiio banana-themed logo and favicon to the Sphinx/Furo documentation and configure the theme to use them.

New Features:

  • Introduce project-specific SVG logo and favicon assets for the Sphinx documentation theme.

Enhancements:

  • Configure Furo theme options and static assets to use the new logo, favicon, and custom stylesheet for consistent branding across light and dark modes.

Documentation:

  • Apply custom styling to constrain the sidebar logo size so it renders appropriately within the documentation layout.

- Add logo-pytest-libiio-banana.svg: banana mascot with purple goggles,
  green pytest checkmarks, circuit traces, and signal waveforms
- Add favicon.svg: 32x32 banana+checkmark+goggle themed favicon with
  dark-mode support via CSS media queries
- Add custom.css: constrain sidebar logo to max-width/height 120/100px
- Update conf.py: configure Furo html_theme_options with light_logo,
  dark_logo, html_logo, html_favicon, html_static_path, html_css_files

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@sourcery-ai
Copy link
Copy Markdown

sourcery-ai Bot commented Mar 2, 2026

Reviewer's Guide

This PR updates the Sphinx/Furo documentation configuration to use new custom pytest/libiio-themed SVG logo and favicon assets, and adds a small CSS override to constrain the sidebar logo size for consistent rendering.

File-Level Changes

Change Details Files
Configure Sphinx/Furo to load custom logo, favicon, and CSS from the _static directory.
  • Set html_static_path to include the _static directory so custom assets are served.
  • Defined html_theme_options with light_logo and dark_logo pointing to the new SVG logo and enabled sidebar_hide_name.
  • Configured html_logo and html_favicon to reference the new logo and favicon assets in _static.
  • Registered custom.css in html_css_files so Furo loads the stylesheet.
docs/conf.py
Add CSS to constrain the sidebar logo size for better layout within the Furo sidebar.
  • Target the .sidebar-brand img selector used by Furo’s sidebar branding area.
  • Limit logo to a maximum width of 120px and height of 100px while keeping aspect ratio via auto width/height.
docs/_static/custom.css
Add pytest/libiio-themed SVG logo and favicon assets for documentation branding.
  • Create a main banana-mascot SVG logo asset for use in the sidebar and header.
  • Create a matching 32x32 SVG favicon asset designed to render crisply at small sizes and support dark-mode via CSS.
docs/_static/logo-pytest-libiio-banana.svg
docs/_static/favicon.svg

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Copy Markdown

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

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

Hey - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

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