markvincze/sabledocs repository overview

⁠Sabledocs

A simple static documentation generator for Protobuf and gRPC contracts.

Demo: You can check out this demo⁠ showing the generated documentation for some of the Google Cloud SDK contracts⁠.

⁠How to use

The markvincze/sabledocs image comes with the protoc CLI and sabledocs preinstalled.

⁠Generate the proto descriptor

In order to build the documentation, you need to generate a binary descriptor from your Proto contracts using protoc.
For example in the folder where your proto files are located, you can execute the following command.

protoc *.proto -o descriptor.pb --include_source_info

(It's important to use the --include_source_info flag, otherwise the comments will not be included in the generated documentation.)

The generated descriptor.pb file will be the input needed to build the documentation site.

⁠Build the documentation

In the same folder where the generated descriptor.pb file is located, execute the command.

sabledocs

The documentation will be generated into a folder sabledocs_output, its main page can be opened with index.html.

⁠Customization

Information about further customization options can be found in the README⁠.