search

adafruit / Wippersnapper_Protobuf

Protocol buffer messages for Adafruit.io WipperSnapper Beta
MIT License
0 stars 2 forks source link

Use Protoc-Gen-Doc for protocol documentation #94

Closed brentru closed 8 months ago

brentru commented 2 years ago

We've been commenting to their style guide, might as well generate readable documentation within this repo!

https://github.com/pseudomuto/protoc-gen-doc

brentru commented 8 months ago

@tyeth Would you be interested in setting protoc-gen-doc up on this repository? We'd push the documentation it generates (only generated for master branch) to a docs/ folder on this repository.

The timebox would be about half a day of work.

Bonus Quest: Generate and publish the HTML documentation pages on github pages

tyeth commented 8 months ago

Closed by https://github.com/adafruit/Wippersnapper_Protobuf/pull/135

GH Pages untested, but docs generation and inclusion in build asset tested.

brentru commented 8 months ago

Documentation is located here: https://adafruit.github.io/Wippersnapper_Protobuf/