Calum Young a98dbcee78 Add meta descriptions to rule pages (#13234) ...

## Summary

This PR updates the `scripts/generate_mkdocs.py` to add meta
descriptions to each rule as well as a fallback `site_description`.

I was initially planning to add this to `generate_docs.rs`; however
running `mdformat` on the rules caused the format of the additional
description to change into a state that mkdocs could not handle.

Fixes #13197 

## Test Plan

- Run  `python scripts/generate_mkdocs.py` to build the documentation
- Run `mkdocs serve -f mkdocs.public.yml` to serve the docs site locally
- Navigate to a rule on both the local site and the current production
site and note the addition of the description head tag. For example:
  - http://127.0.0.1:8000/ruff/rules/unused-import/

![image](https://github.com/user-attachments/assets/f47ae4fa-fe5b-42e1-8874-cb36a2ef2c9b)
  - https://docs.astral.sh/ruff/rules/unused-import/

![image](https://github.com/user-attachments/assets/6a650bff-2fcb-4df2-9cb6-40f66a2a5b8a)

2024-09-09 10:01:59 -04:00

..

benchmarks

Bump version to 0.6.4 (#13253)

2024-09-05 21:05:15 +05:30

fuzz-parser

Remove use of deprecated E999 from the fuzz-parser script (#12150)

2024-07-02 14:18:25 +01:00

knot_benchmark

Make mypy pass on black in knot_benchmark (#13235)

2024-09-04 09:35:58 +00:00

release

Update release script to match uv (#11496)

2024-07-03 07:35:28 -05:00

_mdformat_utils.py

Add a formatting step using mdformat as part of generate_mkdocs.py (#10484)

2024-03-21 00:37:40 +00:00

_utils.py

Use __future__ imports in scripts (#5301)

2023-06-22 11:40:16 -04:00

add_plugin.py

[pydoclint] Implement docstring-missing-exception and docstring-extraneous-exception (DOC501, DOC502) (#11471)

2024-07-20 19:41:51 +00:00

add_rule.py

fixes invalid rule from hyphen (#11484)

2024-05-21 23:39:50 -04:00

check_docs_formatted.py

Format PYI examples in docs as .pyi-file snippets (#13116)

2024-08-28 13:20:40 +01:00

check_ecosystem.py

Remove ecosystem_ci flag from Ruff CLI (#12596)

2024-07-31 11:40:03 -05:00

Dockerfile.ecosystem

Remove outdated feature flag from Dockerfile.ecosystem (#4620)

2023-05-24 08:19:08 +00:00

ecosystem_all_check_entrypoint.sh

Make ecosystem all check more generic (#4629)

2023-05-24 16:26:23 +02:00

ecosystem_all_check.py

Update pre-commit dependencies (#10698)

2024-04-06 23:00:41 +00:00

ecosystem_all_check.sh

Rename Autofix to Fix (#7657)

2023-09-28 10:53:05 +00:00

formatter_ecosystem_checks.sh

Fix the ecosystem check (#10155)

2024-02-28 17:42:06 +00:00

generate_builtin_modules.py

Add a new script to generate builtin module names (#12696)

2024-08-05 21:33:36 +01:00

generate_known_standard_library.py

Add a new script to generate builtin module names (#12696)

2024-08-05 21:33:36 +01:00

generate_mkdocs.py

Add meta descriptions to rule pages (#13234)

2024-09-09 10:01:59 -04:00

pyproject.toml

Update pre-commit dependencies (#13289)

2024-09-09 11:11:01 +00:00

release.sh

Update release script to match uv (#11496)

2024-07-03 07:35:28 -05:00

transform_readme.py

Update pre-commit dependencies (#10698)

2024-04-06 23:00:41 +00:00

update_ambiguous_characters.py

Update pre-commit dependencies (#10698)

2024-04-06 23:00:41 +00:00

update_schemastore.py

Use https by default in schema store update script (#11882)

2024-06-14 17:30:54 -05:00