search

alerque / fluent-lua

Lua implementation of Project Fluent https://projectfluent.org
MIT License
19 stars 4 forks source link

Generate documentation #5

Open alerque opened 5 years ago

alerque commented 5 years ago

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 commented 5 years ago

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 commented 4 years ago

Note the Python implementation has API docs on readthedocs.

alerque commented 2 years ago

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