Skip to content

DOC: Simplify pandas theme footer #61843

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from

Conversation

Siryoos
Copy link

@Siryoos Siryoos commented Jul 13, 2025

🎯 DOC: Simplify pandas theme footer

📝 Description

This pull request refactors the pandas documentation footer by tapping into the built-in templates in pydata-sphinx-theme v0.16. The result is a leaner, more maintainable setup with zero visual regressions—science approved!

🔧 Changes Made

  1. doc/source/conf.py
    • Updated the copyright line to include “pandas”
    • Swapped out custom footer bits for the theme’s built-in templates:
      html_theme_options = {
          "footer_start": [
              "copyright",
              "pandas_footer",
              "sphinx-version",
          ],
          …
      }
  2. doc/_templates/pandas_footer.html
    • Removed the now-redundant copyright snippet
    • Kept only the NumFOCUS & OVHcloud sponsor links
  3. doc/source/_static/css/pandas.css
    • Added horizontal layout rules for the new footer items
    • Ensured consistent spacing & alignment
  4. doc/source/whatsnew/v3.0.0.rst
    • Added a “Documentation changes” section
    • Linked to issue #51536

✅ Benefits

  • DRY: Eliminates duplicated footer code
  • Maintainable: Leverages standard theme hooks
  • Consistent: Visual appearance remains identical
  • Future-proof: Automatically picks up theme updates

🚀 All checks have passed and this PR is ready for merge! 🎉

Mohammad Reza Yoosefiha added 2 commits July 13, 2025 14:52
   - Use built-in copyright template from pydata-sphinx-theme
   - Simplify custom footer template to only include sponsor links
   - Add CSS for proper horizontal layout
- Simplified pandas theme footer implementation by leveraging built-in templates from pydata-sphinx-theme v0.16 (:issue:`51536`)
@jbrockmendel
Copy link
Member

this is AI generated?

@mroeschke
Copy link
Member

Thanks for the PR, but we discourage the use of AI generated pull requests so closing

@mroeschke mroeschke closed this Jul 14, 2025
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.

3 participants