From ffbed692cc17ad6f1fb82734940077dfff6b48b9 Mon Sep 17 00:00:00 2001 From: Adrien Vannson Date: Fri, 10 Jan 2025 22:40:18 +0100 Subject: [PATCH 1/2] Command to serve documentation --- pyproject.toml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/pyproject.toml b/pyproject.toml index 68d33624..40b1ab21 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -99,6 +99,10 @@ help = "Check that the source code is formatted" cmd = "ruff check src tests" help = "Check the code with the Ruff linter" +[tool.poe.tasks.serve-docs] +cmd = "mkdocs serve" +help = "Serve the documentation locally" + [tool.poe.tasks.generate_lib] shell = """ protoc \ From c142b598d913c89fa7aabaad58b5ac3d37f16a63 Mon Sep 17 00:00:00 2001 From: Adrien Vannson Date: Fri, 10 Jan 2025 22:40:34 +0100 Subject: [PATCH 2/2] Warning for Python version --- docs/getting-started.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/getting-started.md b/docs/getting-started.md index fdbd246e..76014e98 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -12,6 +12,9 @@ It is possible to install `betterproto2_compiler` using pip: pip install betterproto2_compiler ``` +!!! warning + The compiler needs Python 3.10, 3.11 or 3.12. Don't worry! The generated code will be compatible with all Python versions from Python 3.8 to Python 3.13. + ## Compile a proto file Create the following `example.proto` file.