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.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4513cdacf7b71037dfc3c33cbc76f2d74c356be9d3f6189b91195a5f5ec2a196 |
|
MD5 | b34aa31971ddba26b9d0b032c6b7cd35 |
|
BLAKE2b-256 | 287c4297d2d0bd88add6babf81c561dba60b7e0d06f1548bb2956fac0bda5f4b |