mirror of
https://github.com/astral-sh/ruff.git
synced 2025-10-03 15:15:33 +00:00
28c9263722
Previously the rule documentation referenced configuration options
via full https:// URLs, which was bad for several reasons:
* changing the website would mean you'd have to change all URLs
* the links didn't work when building mkdocs locally
* the URLs showed up in the `ruff rule` output
* broken references weren't detected by our CI
This commit solves all of these problems by post-processing the
Markdown, recognizing sections such as:
## Options
* `flake8-tidy-imports.ban-relative-imports`
`cargo dev generate-all` will automatically linkify such references
and panic if the referenced option doesn't exist.
Note that the option can also be linked in the other Markdown sections
via e.g. [`flake8-tidy-imports.ban-relative-imports`] since
the post-processing code generates a CommonMark link definition.
Resolves #2766.
|
||
|---|---|---|
| .. | ||
| generate_all.rs | ||
| generate_cli_help.rs | ||
| generate_docs.rs | ||
| generate_json_schema.rs | ||
| generate_options.rs | ||
| generate_rules_table.rs | ||
| main.rs | ||
| print_ast.rs | ||
| print_cst.rs | ||
| print_tokens.rs | ||
| round_trip.rs | ||
| utils.rs | ||