Skip to content

Migrate documentation theme to PyData Sphinx theme #312

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

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

Copilot
Copy link

@Copilot Copilot AI commented Jun 4, 2025

This PR migrates the documentation theme from the Read the Docs theme to the modern PyData Sphinx theme, providing a cleaner and more consistent appearance with other PyData ecosystem projects.

Changes Made

  • Updated dependencies: Replaced sphinx-rtd-theme with pydata-sphinx-theme>=0.13.0 in pyproject.toml
  • Updated Sphinx configuration: Changed html_theme from "sphinx_rtd_theme" to "pydata_sphinx_theme" in docs/source/conf.py
  • Added theme configuration: Integrated GitHub repository links and edit page buttons for better user experience
  • Updated ReadTheDocs config: Migrated from Poetry to UV build system in .readthedocs.yaml to match project tooling

Theme Features

The new PyData Sphinx theme provides:

  • Modern, responsive design with better mobile support
  • GitHub integration with direct links to edit documentation pages
  • Consistent styling with other PyData projects (pandas, NumPy, matplotlib, etc.)
  • Better accessibility and navigation

Testing

  • ✅ Documentation builds successfully with new theme
  • ✅ All existing tests continue to pass
  • ✅ Theme renders correctly with proper styling and navigation
  • ✅ GitHub integration works as expected

The migration maintains all existing documentation content while providing a more modern and user-friendly interface.

Fixes #311.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

@Copilot Copilot AI changed the title [WIP] Migrate documentation theme to PyData Sphinx theme Migrate documentation theme to PyData Sphinx theme Jun 4, 2025
@Copilot Copilot AI requested a review from eh-main-bot June 4, 2025 14:44
Copilot finished work on behalf of eh-main-bot June 4, 2025 14:44
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.

Migrate documentation theme to PyData Sphinx theme
2 participants