mirror of
https://github.com/astral-sh/ruff.git
synced 2025-08-04 02:39:12 +00:00
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.
This commit is contained in:
parent
fa556d1c74
commit
f6d6200aae
17 changed files with 1593 additions and 572 deletions
|
@ -22,14 +22,15 @@ class Section(NamedTuple):
|
|||
SECTIONS: list[Section] = [
|
||||
Section("Overview", "index.md", generated=True),
|
||||
Section("Tutorial", "tutorial.md", generated=False),
|
||||
Section("Installation", "installation.md", generated=False),
|
||||
Section("Usage", "usage.md", generated=False),
|
||||
Section("Configuration", "configuration.md", generated=False),
|
||||
Section("Installing Ruff", "installation.md", generated=False),
|
||||
Section("The Ruff Linter", "linter.md", generated=False),
|
||||
Section("The Ruff Formatter", "formatter.md", generated=False),
|
||||
Section("Configuring Ruff", "configuration.md", generated=False),
|
||||
Section("Preview", "preview.md", generated=False),
|
||||
Section("Rules", "rules.md", generated=True),
|
||||
Section("Settings", "settings.md", generated=True),
|
||||
Section("Editor Integrations", "editor-integrations.md", generated=False),
|
||||
Section("Versioning", "versioning.md", generated=False),
|
||||
Section("Integrations", "integrations.md", generated=False),
|
||||
Section("FAQ", "faq.md", generated=False),
|
||||
Section("Contributing", "contributing.md", generated=True),
|
||||
]
|
||||
|
@ -42,7 +43,7 @@ LINK_REWRITES: dict[str, str] = {
|
|||
"configuration.md#pyprojecttoml-discovery"
|
||||
),
|
||||
"https://docs.astral.sh/ruff/contributing/": "contributing.md",
|
||||
"https://docs.astral.sh/ruff/editor-integrations/": "editor-integrations.md",
|
||||
"https://docs.astral.sh/ruff/integrations/": "integrations.md",
|
||||
"https://docs.astral.sh/ruff/faq/#how-does-ruff-compare-to-flake8": (
|
||||
"faq.md#how-does-ruff-compare-to-flake8"
|
||||
),
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue