Skip to content

Commit 1bcf7fc

Browse files
committed
Populate rst file from specified proto files
1 parent 275d336 commit 1bcf7fc

File tree

4 files changed

+479
-91
lines changed

4 files changed

+479
-91
lines changed

docs/README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,11 +59,50 @@ To manually update Protocol Buffer documentation:
5959
```
6060
3. The script will update `docs/source/ProtobufStructures.rst` with current proto definitions
6161

62+
### Advanced Usage
63+
64+
The generator script supports filtering and configuration:
65+
66+
**Include specific proto files only:**
67+
```sh
68+
python generate_protobuf_docs.py --include SimulatorTables.proto Definitions.proto
69+
```
70+
71+
**Exclude specific proto files:**
72+
```sh
73+
python generate_protobuf_docs.py --exclude Internal.proto Debug.proto
74+
```
75+
76+
**Use a configuration file:**
77+
```sh
78+
python generate_protobuf_docs.py --config proto_docs_config.json
79+
```
80+
81+
**Configuration file format (JSON or YAML):**
82+
```json
83+
{
84+
"include": ["SimulatorTables.proto", "Definitions.proto"],
85+
"exclude": ["Internal.proto"],
86+
"important_messages": ["SimulatorTableData", "Vec3d"]
87+
}
88+
```
89+
90+
**Custom output location:**
91+
```sh
92+
python generate_protobuf_docs.py --output custom.rst --proto-dir /path/to/protos
93+
```
94+
95+
**Command-line help:**
96+
```sh
97+
python generate_protobuf_docs.py --help
98+
```
99+
62100
The generator script parses `.proto` files and creates RST documentation including:
63101
- Message definitions with field types and descriptions
64102
- Enum definitions
65103
- Service definitions (gRPC methods)
66104
- Cross-references to Python API methods
105+
- Highlighting of important/commonly-used structures
67106

68107
## Releasing to Master
69108
Create a pull request from `next-major-release` to the `master` branch.

0 commit comments

Comments
 (0)