google / docsy

A set of Hugo doc templates for launching open source content.
https://docsy.dev
Apache License 2.0
2.61k stars 899 forks source link

Hugo-style API definitions #1674

Open snunez1 opened 1 year ago

snunez1 commented 1 year ago

Does anyone know if the machinery that Hugo uses for it's API documentation is available in Docsy? For example the documentation for the after function. It displays the function parameters, commentary, examples, etc. In some ways it reminds me of Python's Sphinx, which is a nice way to document API's.

Any idea of how to achieve something similar in Docsy?

LisaFC commented 1 year ago

I think they might be just regular docs (with a nice template!) rather than autogenerated - I haven't seen/heard anything about them using a doc generator, and the updates to them look manual.