Skip to content

Migrate to book theme #54

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

Merged
merged 8 commits into from
Oct 5, 2021
Merged

Migrate to book theme #54

merged 8 commits into from
Oct 5, 2021

Conversation

jacobtomlinson
Copy link
Member

@jacobtomlinson jacobtomlinson commented Sep 27, 2021

This PR migrates the Dask Sphinx Theme to use the Executable Book Theme instead of the Read The Docs theme.

Visually I have updated the navigation to look similar to the previous version of the docs but pages and content should feel modernised and refreshed thanks to the Book Theme's nice design.

Incorporates changes from #53.

Notable improvements:

  • Navigation hierarchy is clearer.
    • Top nav is for project level links.
    • Left nav is choosing page within current docs site.
    • Right nav for TOC of the current page.
  • Updated fonts and layouts.
  • Admonitions look modern and refreshed.
  • Scales down to mobile better.
  • Scales up to large screens better.

Before

Screen Shot 2021-09-27 at 15 55 23

After

Screen Shot 2021-09-27 at 15 55 44

More examples

Screen Shot 2021-09-27 at 16 03 56

Screen Shot 2021-09-27 at 16 06 10

Mobile

Copy link
Member

@jsignell jsignell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great!

@jsignell jsignell merged commit b85e847 into dask:main Oct 5, 2021
jacobtomlinson added a commit to dask/dask-stories that referenced this pull request Oct 6, 2021
Bumping the minimum docs theme to use the new version. This isn't strictly necessary but I wanted to raise a PR to trigger the rtd preview and check everything looks ok.

xref dask/dask-sphinx-theme#54
@jrbourbeau jrbourbeau mentioned this pull request Oct 7, 2021
@jacobtomlinson jacobtomlinson deleted the book-theme branch June 20, 2023 16:43
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.

2 participants