You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
## 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.
You can also join us on [**Discord**](https://discord.com/invite/astral-sh).
376
376
377
-
## Support
377
+
## Support<aid="support"></a>
378
378
379
379
Having trouble? Check out the existing issues on [**GitHub**](https://github.com./astral-sh/ruff/issues),
380
380
or feel free to [**open a new one**](https://github.com./astral-sh/ruff/issues/new).
381
381
382
382
You can also ask for help on [**Discord**](https://discord.com/invite/astral-sh).
383
383
384
-
## Acknowledgements
384
+
## Acknowledgements<aid="acknowledgements"></a>
385
385
386
386
Ruff's linter draws on both the APIs and implementation details of many other
387
387
tools in the Python ecosystem, especially [Flake8](https://github.com./PyCQA/flake8), [Pyflakes](https://github.com./PyCQA/pyflakes),
@@ -405,7 +405,7 @@ Ruff is the beneficiary of a large number of [contributors](https://github.com./a
405
405
406
406
Ruff is released under the MIT license.
407
407
408
-
## Who's Using Ruff?
408
+
## Who's Using Ruff?<aid="whos-using-ruff"></a>
409
409
410
410
Ruff is used by a number of major open-source projects and companies, including:
411
411
@@ -524,7 +524,7 @@ If you're using Ruff, consider adding the Ruff badge to your project's `README.m
0 commit comments