Charlie Marsh f6d6200aae Rework the documentation to incorporate the Ruff formatter (#7732) ... ## Summary This PR updates our documentation for the upcoming formatter release. Broadly, the documentation is now structured as follows: - Overview - Tutorial - Installing Ruff - The Ruff Linter - Overview - `ruff check` - Rule selection - Error suppression - Exit codes - The Ruff Formatter - Overview - `ruff format` - Philosophy - Configuration - Format suppression - Exit codes - Black compatibility - Known deviations - Configuring Ruff - pyproject.toml - File discovery - Configuration discovery - CLI - Shell autocompletion - Preview - Rules - Settings - Integrations - `pre-commit` - VS Code - LSP - PyCharm - GitHub Actions - FAQ - Contributing The major changes include: - Removing the "Usage" section from the docs, and instead folding that information into "Integrations" and the new Linter and Formatter sections. - Breaking up "Configuration" into "Configuring Ruff" (for generic configuration), and new Linter- and Formatter-specific sections. - Updating all example configurations to use `[tool.ruff.lint]` and `[tool.ruff.format]`. My suggestion is to pull and build the docs locally, and review by reading them in the browser rather than trying to parse all the code changes. Closes https://github.com/astral-sh/ruff/issues/7235. Closes https://github.com/astral-sh/ruff/issues/7647.		2023-10-20 23:08:26 +00:00
..
.overrides/partials/integrations/analytics	Move some MkDocs responsibilities around (#5542)	2023-07-05 22:06:01 +00:00
assets	Update docs to match updated logo and color palette (#5283)	2023-06-22 11:19:34 -04:00
formatter	Rework the documentation to incorporate the Ruff formatter (#7732)	2023-10-20 23:08:26 +00:00
stylesheets	Render full-width tables in rules reference (#5636)	2023-07-10 02:39:07 +00:00
.gitignore	Fix gitignore to not ignore files that are required (#7538)	2023-09-21 21:33:09 +02:00
configuration.md	Rework the documentation to incorporate the Ruff formatter (#7732)	2023-10-20 23:08:26 +00:00
faq.md	Rework the documentation to incorporate the Ruff formatter (#7732)	2023-10-20 23:08:26 +00:00
formatter.md	Rework the documentation to incorporate the Ruff formatter (#7732)	2023-10-20 23:08:26 +00:00
installation.md	Rework the documentation to incorporate the Ruff formatter (#7732)	2023-10-20 23:08:26 +00:00
integrations.md	Rework the documentation to incorporate the Ruff formatter (#7732)	2023-10-20 23:08:26 +00:00
linter.md	Rework the documentation to incorporate the Ruff formatter (#7732)	2023-10-20 23:08:26 +00:00
preview.md	Rework the documentation to incorporate the Ruff formatter (#7732)	2023-10-20 23:08:26 +00:00
requirements-insiders.txt	Use MkDocs' not_in_nav (#5498)	2023-09-19 00:01:43 +00:00
requirements.txt	Use MkDocs' not_in_nav (#5498)	2023-09-19 00:01:43 +00:00
tutorial.md	Rework the documentation to incorporate the Ruff formatter (#7732)	2023-10-20 23:08:26 +00:00
versioning.md	Add versioning policy to documentation (#7923)	2023-10-12 10:42:35 -05:00