Migrate documentation theme to PyData Sphinx theme#25
Draft
Conversation
Co-authored-by: eh-main-bot <171766998+eh-main-bot@users.noreply.github.com>
Co-authored-by: eh-main-bot <171766998+eh-main-bot@users.noreply.github.com>
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 4, 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 ReadTheDocs theme (
sphinx_rtd_theme) to the modern PyData Sphinx theme (pydata_sphinx_theme), providing a more contemporary and feature-rich documentation experience.Changes Made
Dependencies
pyproject.tomlto replacesphinx-rtd-theme>=3.0.2withpydata-sphinx-theme>=0.13.0Configuration
docs/source/conf.py:html_themefrom"sphinx_rtd_theme"to"pydata_sphinx_theme"_staticdirectory to resolve build warningsTheme Features Added
Verification
tests/docs/test_docs.py)The documentation now has a modern, professional appearance that aligns with other scientific Python projects in the PyData ecosystem while maintaining all existing functionality.
Fixes #24.
Warning
Firewall rules blocked me from connecting to one or more addresses
I tried to connect to the following addresses, but was blocked by firewall rules:
download.pytorch.orguv sync --group docs(dns block)uv add --group docs pydata-sphinx-theme(dns block)uv run --group docs sphinx-build -b html docs/source docs/build(dns block)If you need me to access, download, or install something from one of these locations, you can either:
💡 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.