Skip to content
This repository was archived by the owner on Jun 9, 2025. It is now read-only.

Commit 19228ff

Browse files
Add Python version to documentation, poe command (#26)
* Command to serve documentation * Warning for Python version
1 parent 9c9df60 commit 19228ff

File tree

2 files changed

+7
-0
lines changed

2 files changed

+7
-0
lines changed

docs/getting-started.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ It is possible to install `betterproto2_compiler` using pip:
1212
pip install betterproto2_compiler
1313
```
1414

15+
!!! warning
16+
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.
17+
1518
## Compile a proto file
1619

1720
Create the following `example.proto` file.

pyproject.toml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,10 @@ help = "Check that the source code is formatted"
9999
cmd = "ruff check src tests"
100100
help = "Check the code with the Ruff linter"
101101

102+
[tool.poe.tasks.serve-docs]
103+
cmd = "mkdocs serve"
104+
help = "Serve the documentation locally"
105+
102106
[tool.poe.tasks.generate_lib]
103107
shell = """
104108
protoc \

0 commit comments

Comments
 (0)