Skip to content

Modernize Documentation Theme with Furo #13728

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Modernize Documentation Theme with Furo #13728

wants to merge 3 commits into from

Conversation

@Tejasrahane
Copy link
Contributor

Fixes #12826

Changes Made

This PR modernizes the documentation theme by switching from Alabaster to Furo, a modern and clean Sphinx theme.

Updated pyproject.toml:

  1. Added Furo theme and Sphinx-copybutton to the [dependency-groups] docs section:

    • "furo>=2024.1.29"
    • "sphinx-copybutton>=0.5.2" (optional UX enhancement)

  2. Changed documentation theme from alabaster to furo

  3. Added theme configuration with repository links:

    html_theme_options = {
    "source_repository": "https://github.com/TheAlgorithms/Python/",
    "source_branch": "master",
    "source_directory": "docs/",
}

Benefits

  • Modern, clean, and responsive design
  • Better mobile support
  • Improved navigation and search
  • Dark mode support
  • Enhanced copy button for code blocks

@algorithms-keeper algorithms-keeper bot added the tests are failing Do not merge until tests pass label Oct 24, 2025
@Tejasrahane
Fix TOML syntax: Convert html_theme_options to single-line inline table
ccf2265 
TOML inline tables (using {}) cannot span multiple lines. Fixed the html_theme_options dictionary to be a single-line inline table to resolve the sphinx build_docs check failure.
@algorithms-keeper algorithms-keeper bot added the awaiting reviews This PR is ready to be reviewed label Oct 24, 2025
@algorithms-keeper algorithms-keeper bot removed tests are failing Do not merge until tests pass labels Oct 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@mindaugl mindaugl mindaugl approved these changes

Reviewers whose approvals may not affect merge requirements

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

awaiting reviews This PR is ready to be reviewed

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Modernize Documentation Theme with Furo

2 participants

@Tejasrahane @mindaugl