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

Switch to Furo theme #77

Closed
simonw opened this issue May 20, 2022 · 4 comments
Closed

Switch to Furo theme #77

simonw opened this issue May 20, 2022 · 4 comments
Labels
documentation Improvements or additions to documentation

Comments

@simonw
Copy link
Owner

simonw commented May 20, 2022

Suggested by Adam Johnson - Furo looks neat. I like that it doesn't use any web fonts so should load faster.

In my local dev environment (make livehtml so this includes the live reload stuff) Furo uses 257KB for a full reload compared to 842KB for sphinx_rtd_theme.

@simonw simonw added the documentation Improvements or additions to documentation label May 20, 2022
@simonw simonw closed this as completed in 40e6872 May 20, 2022
@simonw
Copy link
Owner Author

simonw commented May 20, 2022

OK, deployed that for latest - https://shot-scraper.datasette.io/en/latest/ now shows 218.16KB transferred in the network pane, compared to 627.84KB for https://shot-scraper.datasette.io/en/stable/

@simonw
Copy link
Owner Author

simonw commented May 20, 2022

Comparison:

shot-scraper https://shot-scraper.datasette.io/en/stable/ --retina --height 1200

shot-scraper-datasette-io-en-stable

shot-scraper https://shot-scraper.datasette.io/en/latest/ --retina --height 1200

shot-scraper-datasette-io-en-latest

@simonw
Copy link
Owner Author

simonw commented May 20, 2022

Just spotted this note in the Furo docs: https://pradyunsg.me/furo/customisation/sidebar/#using-html-sidebars

If you’re hosting your documentation on Read the Docs, please make sure that sidebar/ethical-ads.html is included in the sidebar. This helps keep Read the Docs sustainable.

@simonw
Copy link
Owner Author

simonw commented May 20, 2022

I think I'm OK there - I don't set a custom html_sidebars in my conf.py and it looks like it includes those on Read The Docs by default - I found this in the generated HTML in production:

<div
  id="furo-sidebar-ad-placement"
  class="flat"
  data-ea-publisher="readthedocs"
  data-ea-type="readthedocs-sidebar"
  data-ea-manual="true"
></div>
</div>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant