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.

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

docs: Switch theme from furo to pydata-sphinx-theme; Remove tippy extension. #49

Merged
merged 8 commits into from
Mar 15, 2024
Merged

docs: Switch theme from furo to pydata-sphinx-theme; Remove tippy extension. #49

merged 8 commits into from
Mar 15, 2024

Conversation

kirkrodrigues
Copy link
Member

@kirkrodrigues kirkrodrigues commented Mar 15, 2024 •
edited
Loading

Description

This PR:

  • Switches the docs theme from furo to pydata-sphinx-theme because the latter has built-in support for a version-switcher.
    • We also customize the theme with colours more similar to YScope's logo and work around some layout issues.
  • Removes the sphinx-tippy extension since it's quite distracting without adding much value.
  • Updates all docs requirements to the latest versions.

NOTE: We now require Python 3.10 to build the docs.

This PR depends on #46 and #48 being merged first.

Validation performed

Validated task docs:serve built and served the new docs site.

@kirkrodrigues kirkrodrigues merged commit 67592fa into y-scope:main Mar 15, 2024
@kirkrodrigues kirkrodrigues deleted the switch-docs-theme branch March 15, 2024 21:19
@kirkrodrigues kirkrodrigues mentioned this pull request Mar 15, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@haiqi96 haiqi96 haiqi96 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@kirkrodrigues @haiqi96