Use uv workspaces instead of pip

CONTRIBUTING.md

@@ -294,28 +294,30 @@ Finally, regenerate the documentation and generated code with `cargo dev generat
 
 To preview any changes to the documentation locally:
 
-1. Install the [Rust toolchain](https://www.rust-lang.org/tools/install).
+1. Install the [Rust toolchain](https://www.rust-lang.org/tools/install).]
 
-1. Install MkDocs and Material for MkDocs with:
+1. Install [uv](https://docs.astral.sh/uv/installation/)
+
+1. Install the dependencies
 
     ```shell
-    pip install -r docs/requirements.txt
+    uv sync
     ```
 
 1. Generate the MkDocs site with:
 
     ```shell
-    python scripts/generate_mkdocs.py
+    uv run scripts/generate_mkdocs.py
     ```
 
 1. Run the development server with:
 
     ```shell
     # For contributors.
-    mkdocs serve -f mkdocs.public.yml
+    uv run -- mkdocs serve -f mkdocs.public.yml
 
     # For members of the Astral org, which has access to MkDocs Insiders via sponsorship.
-    mkdocs serve -f mkdocs.insiders.yml
+    uv run --with-requirements docs/requirements-insiders.txt -- mkdocs serve -f mkdocs.insiders.yml
     ```
 
 The documentation should then be available locally at

docs/pyproject.toml

@@ -0,0 +1,20 @@
+[project]
+name = "ruff-docs"
+version = "0.0.0"
+dependencies = [
+  "PyYAML>=6.0.1",
+  "mkdocs>=1.5.0",
+  "mdformat>=0.7.17",
+  "mdformat-mkdocs>=2.0.4",
+  "mdformat-admon>=2.0.3",
+  "mkdocs-material>=9.1.18",
+  "mkdocs-redirects>=1.2.1",
+]
+requires-python = ">=3.8"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/ruff_docs"]

docs/requirements-insiders.txt

@@ -1,8 +1 @@
-PyYAML==6.0.1
-black==23.10.0
-mkdocs==1.5.0
 mkdocs-material @ git+ssh://git@github.com/astral-sh/mkdocs-material-insiders.git@38c0b8187325c3bab386b666daf3518ac036f2f4
-mkdocs-redirects==1.2.1
-mdformat==0.7.17
-mdformat-mkdocs==2.0.4
-mdformat-admon==2.0.2

pyproject.toml

@@ -43,6 +43,9 @@ Repository = "https://github.com/astral-sh/ruff"
 Documentation = "https://docs.astral.sh/ruff/"
 Changelog = "https://github.com/astral-sh/ruff/blob/main/CHANGELOG.md"
 
+[tool.uv.workspace]
+members = ["docs", "python/ruff-ecosystem"]
+
 [tool.maturin]
 bindings = "bin"
 manifest-path = "crates/ruff/Cargo.toml"

scripts/generate_mkdocs.py

@@ -161,7 +161,7 @@ def main() -> None:
     # Format rules docs
     add_no_escape_text_plugin()
     for rule_doc in Path("docs/rules").glob("*.md"):
-        mdformat.file(rule_doc, extensions=["mkdocs", "admonition", "no-escape-text"])
+        mdformat.file(rule_doc, extensions=["mkdocs", "admon", "no-escape-text"])
 
     with Path("mkdocs.template.yml").open(encoding="utf8") as fp:
         config = yaml.safe_load(fp)