writethedocs / www

The main website for Write the Docs.
http://www.writethedocs.org
Other
1.32k stars 507 forks source link

add furo theme on sphinx-themes #2005

Closed EFord36 closed 1 year ago

EFord36 commented 1 year ago

Hi,

I saw a suggestion to open PRs with sphinx themes at https://www.writethedocs.org/guide/tools/sphinx-themes/:

These are the Sphinx themes that we recommend. If there are any others you like, feel free to open a pull request to add them.

I've been using furo for my project (kazu, docs here) for a while now and really like it - I thought the least I could do in return was this PR to publicise.

More justification:

The theme is Used by urllib, attrs, pip, python developer's guide, black

I also see it mentioned in this issue: https://github.com/writethedocs/www/issues/1516 :

  • what do people think about themes?

    • furo

Which I interpret as probably a suggestion that furo should be included on this page (but the notes are raw, so I may be wrong here).

I'm not overly attached to the wording (or the screenshot in particular!), and I'm not a developer of the theme, so feel free to amend, I just thought I'd start the ball rolling on getting it included here.

I previewed locally and it looked fine to me.


:books: Documentation preview :books:: https://writethedocs-www--2005.org.readthedocs.build/

ericholscher commented 1 year ago

Thanks! Love Furo :)