Skip to content
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

Use furo theme for documentation #1077

Merged
merged 6 commits into from Apr 10, 2023
Merged

Use furo theme for documentation #1077

merged 6 commits into from Apr 10, 2023

Conversation

tommy-waltmann
Copy link
Collaborator

Description

This PR changes the documentation theme from the sphinx readthedocs theme to the furo theme.

Motivation and Context

The furo theme is more customizable, has better search display, different lighting modes, and overall looks a bit cleaner than the the readthedocs theme.

How Has This Been Tested?

readthedocs will build and render the documentation changes in the new theme by default.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds or improves functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation improvement (updates to user guides, docstrings, or developer docs)

Checklist:

  • I have read the CONTRIBUTING document.
  • My code follows the code style of this project.
  • I have updated the documentation (if relevant).
  • I have added tests that cover my changes (if relevant).
  • All new and existing tests passed.
  • I have updated the credits.
  • I have updated the Changelog.

@tommy-waltmann tommy-waltmann marked this pull request as ready for review March 17, 2023 14:17
@tommy-waltmann tommy-waltmann requested a review from a team as a code owner March 17, 2023 14:17
@tommy-waltmann tommy-waltmann requested review from gaofy95 and removed request for a team March 17, 2023 14:17
@tommy-waltmann tommy-waltmann merged commit 4012b46 into master Apr 10, 2023
24 checks passed
@tommy-waltmann tommy-waltmann deleted the use-furo branch April 10, 2023 14:03
@tommy-waltmann tommy-waltmann added this to the v2.13.0 milestone Apr 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants