search

hit9 / bitproto

The bit level data interchange format for serializing data structures (long term maintenance).
https://bitproto.readthedocs.io/
BSD 3-Clause "New" or "Revised" License
127 stars 16 forks source link

Auto-generate rst documentation for serialization structures #56

Closed mprudky closed 4 months ago

mprudky commented 4 months ago

Add a script, which will allow to generate .rst documentation for the given bit proto schema.

Rationale: Schemas often represents messages being exchanged between the devices and messages needs documentation in human readable form. Bitproto already supports generation of the serialization/deserialization source code. Having auto generation of the documentation should add additional great value to the bitproto.

hit9 commented 4 months ago

Nice idea, but I don't have time to do it.

Pull requests are welcome :)