Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add anchor tags to README headers (#13083)
## Summary This pull request adds anchor tags to the elements referenced in the table of contents section of the readme used on [PyPI](https://pypi.org/project/ruff/) as an attempt to fix #7257. This update follows [this suggestion](pypa/readme_renderer#169 (comment)) 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](pypa/readme_renderer#169 (comment)) and [this suggestion](pypa/readme_renderer#169 (comment)) all suggest that this approach should work.
- Loading branch information