Add anchor tags to README headers

[calumy]

Summary

This pull request adds anchor tags to the elements referenced in the table of contents section of the readme used on PyPI as an attempt to fix #7257. This update follows this suggestion to add anchor tags (with no spaces) after the title that is to be linked to.

Test Plan

• This has been tested on GitHub to check that the additional tags do not interfere with how the read me is rendered; see: https://github.com/calumy/ruff/blob/add-links-to-pypi-docs/README.md
• MK docs were generated using the generate_mkdocs.py script; however as the added tags are beyond the comment <!-- End section: Overview -->, they are excluded so will not change how the docs are rendered.
• I was unable to verify how PyPI renders this change, any suggestions would be appreciated and I can follow up on this. Hopefully, the four thumbs up/heart on this comment and this suggestion all suggest that this approach should work.

[dhruvmanila]

Thanks!

I think it should work on PyPI as well based on https://github.com/databricks/databricks-sdk-py/blob/main/README.md?plain=1 and https://pypi.org/project/databricks-sdk.

[calumy]

Thanks!

I think it should work on PyPI as well based on https://github.com/databricks/databricks-sdk-py/blob/main/README.md?plain=1 and https://pypi.org/project/databricks-sdk.

Thanks for finding an example, I couldn't find one at the time of writing the PR.