Markdown protocol buffer code generator
Project description
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for md_protobuf-1.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3ebb80c6223a42d507e2e4445d273018fab2d96c93043fcb4aa1daaed06f0dc2 |
|
MD5 | 60947e4a7e3f233a1cf622702b6733fb |
|
BLAKE2b-256 | 2ee05cfb771db2b960f03e13556b8349caef6532effd71b9115412267e8fb52a |