md-protobuf provides a Markdown interface to Google's Protocol Buffers
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-2.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1d5fe999e5a3e42e6ecca3d0e7f0f8ca2f17a662c4b98edea7b2b4ef1821c326 |
|
MD5 | 9cda3f053c9afa3b897a0fc814762a28 |
|
BLAKE2b-256 | c90e0df5f1f62cd5cbebc79e213a2fb80a67c52f6c3a302890a431d992b4326f |