ScaleableWebWorks/grpcdoc

cli to generate comprehensive html documentation for grpc/protobuf

grpcdoc

Create comprehensive html documentation from your grpc/protobuf files.

grpcdoc is a command line tool written in golang which takes grpc/protobuf files and generates a comprehensive html documentation for it.

Installation

Using Homebrew

brew tap ScaleableWebWorks/grpcdoc
brew install grpcdoc

Manual installation

1. Go to releases
2. Download the latest version for your operating system
3. Unzip the file
4. Move the binary to a location in your path
5. Run grpcdoc in your terminal

Usage example

Create a documentation for a single file

grpcdoc -out doc.html ./path/to/your/file.proto

Create a documentation for multiple files

grpcdoc -out doc.html ./path/to/your/file1.proto ./path/to/your/file2.proto

Read all .proto files from a directory

grpcdoc -out doc.html ./path/to/your/protos

Create a documentation for multiple files and include a custom css file

grpcdoc -out doc.html -style custom.css ./path/to/your/file1.proto

Read proto file from stdin

cat ../examples/example.proto | grpcdoc > doc.html

Generate and serve documentation on localhost:8000

grpcdoc -http=:8000 ./path/to/your/file.proto

For more examples and usage, please refer to the Wiki.

Development setup

To start development you need to have golang installed on your system.

git clone https://github.com/ScaleableWebWorks/grpcdoc.git
cd grpcdoc

go get
go build

Release History

• 0.0.1
  • Initial version Work in progress

Meta

Marco Rico – @mricog – marco@scaleablewebworks.com

Distributed under the MIT license. See LICENSE for more information.

https://github.com/ScaleableWebWorks

Contributing

1. Fork it (https://github.com/ScaleableWebWorks/grpcdoc/fork)
2. Create your feature branch (git checkout -b feature/fooBar)
3. Commit your changes (git commit -am 'Add some fooBar')
4. Push to the branch (git push origin feature/fooBar)
5. Create a new Pull Request