docs: style Python API reference docs

[dgarcia360]

Related scylladb/sphinx-scylladb-theme#1516

How to test

1. Build the docs.
2. Open the API reference.
3. Review the new UI at http://127.0.0.1:5500/api/

[dgarcia360]

cc/ @annastuchlik

[Lorak-mmk]

I rendered docs before and after this PR.
Before:

After:

The only difference I see is that the short descriptions of docs chapters were removed - which is imo a regression.

The unreadable style of docs was not fixed. See this:

This is basically a wall of test. Compare this with pytest docs (which is also made with Sphinx!).

• Class / method / field names are clearly visible in red, so you always know which section some text belongs to.
• Indentations clearly show which class a method belongs to, and also which method given doc text belongs to.

[dgarcia360]

@Lorak-mmk commited uv.lock in https://github.com/scylladb/python-driver/pull/593/commits/de80de7770f1b78af6f5f61b1651ef27ce8ecaecusing latest theme version.

Please try again.

[Lorak-mmk]

This is current state:

It's much better, a clear improvement over what we had until now!

If I may have some suggestions (which are possibly out of scope for this PR, idk):

• I love that list on the right is now collapsible. It would be great if it was possible to expand / collapse given section without jumping to it, by clicking on the small arrow in the section.
• To add to that, maybe consider "collapse all" / "expand all" button?
• Color schema is all black / white / gray. Docs for devs should be easy to glance at after many hours of work when brain and eyes are tired. Most devs are also used to colorful syntax highlighting in their IDEs. Please consider changing the colors for things like class names, method names etc.

[dgarcia360]

Thanks @Lorak-mmk for the feedback! Moved the improvements here to take them into account in a future version of the theme.