Change documentation theme to Furo

[pradyunsg]

I'll add a changelog entry, if we have agreement that this is the direction we want to take. :)

[webknjaz]

👍 I like the idea of having a unified docs theme across the PyPA projects.

@jaraco: The ToCs are removed because the furo theme adds its own ToC on each page, in the right sidebar, and is opinionated about not having it duplicated in the corresponding document body.

@pradyunsg: Is pradyunsg/furo@b6c7c76 released? If yes, you could close+reopen this PR to retrigger Netlify and have it build the preview.

[jaraco]

Is pradyunsg/furo@b6c7c76 released? If yes, you could close+reopen this PR to retrigger Netlify and have it build the preview.

I just closed, re-opened, and still had to manually re-deploy, but the error is emitted:

12:20:18 PM: Warning, treated as error:
12:20:18 PM: the furo extension does not declare if it is safe for parallel reading, assuming it isn't - please ask the extension author to check and make it explicit
ERROR: InvocationError for command /opt/build/repo/.tox/docs/bin/python -m sphinx -j auto -b html --color -a -n -W -d /opt/build/repo/.tox/.tmp/.doctrees . /opt/build/repo/build/html (exited with code 2)

That suggests the fix is not released. Also, that commit is not present in any tags.

[pradyunsg]

@pradyunsg: Is pradyunsg/furo@b6c7c76 released? If yes, you could close+reopen this PR to retrigger Netlify and have it build the preview.

Not yet, no.

[pradyunsg]

@jaraco Try redeploying now?

[webknjaz]

@pradyunsg looks like netlify doesn't do rebuilds on reopen. Try rebasing the PR.

[pradyunsg]

This removed the tidelift contents from the sidebar.

It'd probably be a good idea to mimic how urllib3 handles the Tidelift callout: https://urllib3.readthedocs.io/en/latest/_sources/index.rst.txt, https://urllib3.readthedocs.io/en/latest/. Let me know if that's desirable and I'll amend this PR for that. :)

[jaraco]

Happy to mimic urllib3. I'd like to apply the changes to every tidelift-sponsored project. Let's apply the concept to jaraco/tidelift first, then I can merge the change into setuptools main.

[jaraco]

I've started working on generalizing the urllib3 technique in jaraco/tidelift#2, but I'm yet unsuccessful in substituting the project name, so could use some help there.

[webknjaz]

This PR needs a rebase and here's the demo of solving the Tidelift problem: #2708.

[webknjaz]

@pradyunsg plz rebase this — it should be unlocked now.