История

Adam Ryman 242950a142 Restructure truss's output to new file structure truss's output structure now looks like the following where NAME is the package name of the definition file . ├── NAME-service │ ├── docs │ │ └── docs.md │ ├── generated │ │ └── ... │ ├── handlers │ │ ├── client │ │ │ └── client_handler.go │ │ └── server │ │ └── server_handler.go │ ├── NAME-client │ │ └── client_main.go │ ├── NAME-server │ │ └── server_main.go │ └── svc.pb.go ├── svc.proto └── third_party └── ... Now go build ./... is possible from the root directory. truss no longer builds the server or client. These changes have been reflected in the integration_tests where the integration runner now builds the services. See ./truss/integration_tests/README.md for more details Add USAGE.md to root to describe the file modification agreement		2016-09-16 12:03:59 -07:00
..
README.md	Major truss refactor	2016-08-17 19:26:35 -07:00
docs_css.go	Separate doc generation from definition structure	2016-09-12 11:37:15 -07:00
gendoc.go	Restructure truss's output to new file structure	2016-09-16 12:03:59 -07:00
generate_markdown.go	Separate doc generation from definition structure	2016-09-12 11:37:15 -07:00

README.md

`gendocs`

A truss plugin which can generate documentation from an annotated Protobuf definition file. Handles http-options.

Limitations and Bugs

Currently, there are a variety of limitations in the documentation parser.

Having additional http bindings via the additional_bindings directive when declaring http options causes the parser to break.