search

pseudomuto / protoc-gen-doc

Documentation generator plugin for Google Protocol Buffers
MIT License
2.59k stars 462 forks source link

reStructuredText format output #440

Open paweld2 opened 3 years ago

paweld2 commented 3 years ago

A proposition for reStructuredText format output.

The output is compatible with sphinx. No content table is provided, because it is generated by sphinx.

HTML and Latex output tested.

The references and links are correctly matched: ".. _ref_NAME:" matches ":ref:NAME"

The tables are created in the CVS format.

It is not possible to create references to table row values, that is why for each scalar value a separate subsection is created.

paweld2 commented 3 years ago

@pseudomuto please review.

I know that custom templates are supported, but I assume that solving the specific reStructuredText issues has value for more that one person.

kumare3 commented 3 years ago

@paweld2 we are interested in rst support for the flyte.org project. Let us know if we can help test cc @pmahindrakar-oss

kumare3 commented 3 years ago

@paweld2 we used this for generating Flyte.org docs and works beautifully. @pseudomuto what would the process to get this checked in?