Change base theme to Furo?

[pradyunsg]

I've been spending a lot of time around Sphinx documentation stuff lately, and have a suggestion to make regarding our documentation theme (partly from my recent experience revamping pypa/packaging.python.org#627).

Suggestion: Let's switch to Furo for our base theme here. I think it'll help our documentation overall (especially pip and packaging.python.org), since it's better at surfacing the documentation structure and has better navigational capabilities throughout.

Pros:

• Provides structured, clear sidebar navigation.
• Responsive!
• Has a fairly more "modern" design.
• Has a right sidebar that provides in-page navigation.
• Dark mode. :)

Cons:

• Not python-docs-theme, which distances us from CPython documentation.

/cc @ncoghlan @dstufft @theacodes since they were fairly active in the original discussion for the creation of this theme.

[theacodes]

I prefer to stick closely to the upstream python docs theme, but I no longer have much of stake here.

…

On Sun, Nov 1, 2020, 8:04 PM Pradyun Gedam ***@***.***> wrote: I've been spending a lot of time around Sphinx documentation stuff lately, and have a suggestion to make regarding our documentation theme (partly from my recent experience revamping pypa/packaging.python.org#627 <pypa/packaging.python.org#627>. Suggestion: Let's switch to Furo <http://pradyunsg.me/furo/quickstart> for our base theme here. I think it'll help our documentation overall (especially pip and packaging.python.org), since it's better at surfacing the documentation structure and has better navigational capabilities throughout. Pros: - Provides structured, clear sidebar navigation. - Responsive! - Has a fairly more "modern" design. - Has a right sidebar that provides in-page navigation. - Dark mode. :) Cons: - Not python-docs-theme, which distances us from CPython documentation. /cc @ncoghlan <https://github.com/ncoghlan> @dstufft <https://github.com/dstufft> @theacodes <https://github.com/theacodes> since they were fairly active in the original discussion for the creation of this theme. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#18>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAB5I43VKQFRN27RH2CYE3TSNYATBANCNFSM4TG3Z5LA> .

[pradyunsg]

There's now pypa/packaging.python.org#791, for migrating packaging.python.org to Furo, and pip's documentation has already been moved to Furo. Looking at #8, these were the only 2 projects that are using this theme.

[ichard26]

FYI, pypa/bandersnatch does use this theme.

[jeanas]

I would really love this since some of the guides are quite long and Furo's right sidebar with the TOC of the current page is super helpful for reading those.

[willingc]

@pradyunsg It would be awesome to update this theme to be more in line with the python dev guide.

[astrojuanlu]

I see the dev guide uses Furo at the moment: https://github.com/python/devguide/blob/e95f9085085c580923a883fa15574428e108ba4a/conf.py#L39

[jeanas]

Now that packaging.python.org uses Furo (pypa/packaging.python.org#1354), this issue is done — and I guess the whole repository should be archived.

[pradyunsg]

This can definitely be closed!

[pradyunsg]

https://github.com/search?utf8=%E2%9C%93&q=pypa_docs_theme++org%3Apypa&type=code

Hmm... archiving this might indeed make sense.

[jeanas]

There seem to be no objections to archiving…

[chrysle]

@pradyunsg I'd be in favour, too, but can't do it, as PyPUG editors do not have admin access to this repo.