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
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 4 additions & 7 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,8 @@ build:
python: "3.10"
jobs:
post_create_environment:
# Install poetry
# https://python-poetry.org/docs/#installing-manually
- pip install poetry
# Install uv
- pip install uv
post_install:
# Install dependencies with 'docs' dependency group
# https://python-poetry.org/docs/managing-dependencies/#dependency-groups
# VIRTUAL_ENV needs to be set manually for now, see #11150
- VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH poetry install
# Install dependencies with 'docs' dependency group using uv
- uv sync --group docs --frozen --no-group dev
15 changes: 14 additions & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,19 @@
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

html_theme = "sphinx_rtd_theme"
html_theme = "pydata_sphinx_theme"
master_doc = "index"
html_static_path = []

# Theme options
html_theme_options = {
"github_url": "https://github.com/DanielAvdar/pandas-pyarrow",
"use_edit_page_button": True,
}

html_context = {
"github_user": "DanielAvdar",
"github_repo": "pandas-pyarrow",
"github_version": "main",
"doc_path": "docs/source",
}
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ dev = [
docs = [
"sphinx>=8.2.0; python_version >= '3.11'",
"sphinx>=7.0.0; python_version < '3.11'",
"sphinx-rtd-theme>=3.0.2",
"pydata-sphinx-theme>=0.13.0",
]

[tool.ruff]
Expand Down
88 changes: 56 additions & 32 deletions uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.