Skip to main content

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

md_protobuf-2.0.1.tar.gz (7.6 kB view hashes)

Uploaded Source

Built Distribution

md_protobuf-2.0.1-py3-none-any.whl (8.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page