Migrate documentation theme to PyData Sphinx theme#192
Merged
DanielAvdar merged 2 commits intomainfrom Jun 6, 2025
Merged
Conversation
- Replace sphinx-rtd-theme with pydata-sphinx-theme in dependencies - Update html_theme setting in Sphinx configuration - Add PyData theme configuration options including GitHub integration - Remove duplicate sphinx.ext.autodoc extension entry - Test documentation builds successfully with new theme Co-authored-by: eh-main-bot <171766998+eh-main-bot@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Migrate documentation theme to PyData Sphinx theme
Migrate documentation theme to PyData Sphinx theme
Jun 6, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR migrates the documentation theme from the Read the Docs theme to the PyData Sphinx theme, providing a more modern and feature-rich documentation experience.
Changes Made
sphinx-rtd-theme>=3.0.2withpydata-sphinx-theme>=0.15.0inpyproject.tomlhtml_themefrom"sphinx_rtd_theme"to"pydata_sphinx_theme"indocs/source/conf.pysphinx.ext.autodocextension entryBenefits
The PyData Sphinx theme provides:
Testing
make doc,make doctest) continue to workThe migration maintains full backward compatibility while providing an improved user experience for documentation readers.
Fixes #184.
💡 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.