fluent-lua icon indicating copy to clipboard operation
fluent-lua copied to clipboard

Generate documentation

Open alerque opened this issue 6 years ago • 3 comments

What's the best way these days to generate documentation of a Lua module? Obviously some very basics will go in the README, but is there a way to publish to easily publish Lua API docs to readthedocs.io or similar? Or a way to generate gh-pages from code comments?

alerque avatar Sep 13 '19 13:09 alerque

Tools to keep in mind seem like LDoc and readthedocs. Look into where other Fluent implementations are putting documentation and if there is a trend, maybe use the same thing for consistency and ease of comparing implementations.

alerque avatar Sep 18 '19 07:09 alerque

Note the Python implementation has API docs on readthedocs.

alerque avatar Sep 23 '19 09:09 alerque

This issue probably dates back to before I was the LDoc maintainer. Gee I wonder what tool I should use for this.

alerque avatar Mar 10 '22 21:03 alerque