From f8f2e2a442aae2c1dfb4949e5ce99dc7a9d3e902 Mon Sep 17 00:00:00 2001 From: Calum Young <32770960+calumy@users.noreply.github.com> Date: Mon, 26 Aug 2024 08:12:35 +0100 Subject: [PATCH] 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](https://github.com/pypa/readme_renderer/issues/169#issuecomment-808577486) 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 ``, 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](https://github.com/pypa/readme_renderer/issues/169#issuecomment-808577486) and [this suggestion](https://github.com/pypa/readme_renderer/issues/169#issuecomment-1765616890) all suggest that this approach should work. --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 2aacb27e5aef9..eb65a19e9b607 100644 --- a/README.md +++ b/README.md @@ -110,7 +110,7 @@ For more, see the [documentation](https://docs.astral.sh/ruff/). 1. [Who's Using Ruff?](#whos-using-ruff) 1. [License](#license) -## Getting Started +## Getting Started For more, see the [documentation](https://docs.astral.sh/ruff/). @@ -195,7 +195,7 @@ jobs: - uses: chartboost/ruff-action@v1 ``` -### Configuration +### Configuration Ruff can be configured through a `pyproject.toml`, `ruff.toml`, or `.ruff.toml` file (see: [_Configuration_](https://docs.astral.sh/ruff/configuration/), or [_Settings_](https://docs.astral.sh/ruff/settings/) @@ -291,7 +291,7 @@ features that may change prior to stabilization. See `ruff help` for more on Ruff's top-level commands, or `ruff help check` and `ruff help format` for more on the linting and formatting commands, respectively. -## Rules +## Rules @@ -367,21 +367,21 @@ quality tools, including: For a complete enumeration of the supported rules, see [_Rules_](https://docs.astral.sh/ruff/rules/). -## Contributing +## Contributing Contributions are welcome and highly appreciated. To get started, check out the [**contributing guidelines**](https://docs.astral.sh/ruff/contributing/). You can also join us on [**Discord**](https://discord.com/invite/astral-sh). -## Support +## Support Having trouble? Check out the existing issues on [**GitHub**](https://github.com/astral-sh/ruff/issues), or feel free to [**open a new one**](https://github.com/astral-sh/ruff/issues/new). You can also ask for help on [**Discord**](https://discord.com/invite/astral-sh). -## Acknowledgements +## Acknowledgements Ruff's linter draws on both the APIs and implementation details of many other 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 Ruff is released under the MIT license. -## Who's Using Ruff? +## Who's Using Ruff? Ruff is used by a number of major open-source projects and companies, including: @@ -524,7 +524,7 @@ If you're using Ruff, consider adding the Ruff badge to your project's `README.m Ruff ``` -## License +## License This repository is licensed under the [MIT License](https://github.com/astral-sh/ruff/blob/main/LICENSE)