Skip to content

DOC Update website to pydata-sphinx-theme #28084

@Charlie-XIAO

Description

@Charlie-XIAO

This issue is a continuation of #26809 and aims to migrate the scikit-learn website towards pydata-sphinx-theme. As this is an ambitious goal, this issue is to track the steps of the migration. cc @lucyleeow who guided me to open this issue.

Quick links

TODO before merging into main

  • doc-min-dependencies is bypassed in CI for now and we need to reactivate it before merging into main. Also, we need to make sure all dependencies are documented, in particular sphinx-design which was not added in the very first setup PR. See also #28379.
  • Remove the new_web_theme part in .circleci/config.yml.
  • In conf.py, change the version switcher link to https://scikit-learn.org/dev/_static/versions.json.
  • Remove themes/ and update exclude_patterns in conf.py: these are only useful for the old theme.
  • Pin higher versions of sphinx, pydata-sphinx-theme, and sphinx-gallery. See also tracker for upstream issues.

Tracking work towards the new_web_theme branch

Tracking work related by towards the main branch

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    Status

    Done

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions