md-protobuf provides a generator for generating mardown documnetation files from google protocol buffer files.
Producing Code
md-protobuf provides a plugin for the protoc protocol buffer compiler (it ships with protocol buffers). This plugin tells protoc to produce a set of mardown output files, which contains documentation derived from the comments in the proto file.
First, obtain a copy of md-protobuf:
$ git clone git@github.com:mickem/md-protobuf.git
$ cd md-protobuf
Next, install md-protobuf:
$ python setup.py install
Finally, launch protoc and tell it to produce Md output:
$ protoc -I/path/to/your/proto/files --md_out=/output/path file1.proto file2.proto
You simply need to add --md_out to the arguments to protoc to get it to produce the Markdown output files.
Under the hood, protoc is looking for the program protoc-gen-md somewhere in your $PATH. You can modify $PATH in lieux of installing the package, if you desire.
1 maintainer
Metadata
1 maintainer
Release files for md-protobuf 2.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| md_protobuf-2.0.1.tar.gz | 7.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| md_protobuf-2.0.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 16.5 kB
Release files / md_protobuf-2.0.1.tar.gz
| Download URL | md_protobuf-2.0.1.tar.gz |
|---|---|
| Size | 7.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
52d815fcd295971c841fac64861fa82dce5aa3a89039cec3a23f79add50e7acf
|
|
BLAKE2b-256 checksum How to use checksums |
f637df52105ccf04b383f541db712d39b5190a106c6fc8bfc39d2a75ba06f986
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.6.1 CPython/3.11.4 Windows/10
|
Release files / md_protobuf-2.0.1-py3-none-any.whl
| Download URL | md_protobuf-2.0.1-py3-none-any.whl |
|---|---|
| Size | 8.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
4513cdacf7b71037dfc3c33cbc76f2d74c356be9d3f6189b91195a5f5ec2a196
|
|
BLAKE2b-256 checksum How to use checksums |
287c4297d2d0bd88add6babf81c561dba60b7e0d06f1548bb2956fac0bda5f4b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.6.1 CPython/3.11.4 Windows/10
|
