Skip to content

Generate documentation #5

Open
Open

Description

@alerque

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?

Activity

  1. added
    documentationImprovements or additions to documentation
    questionFurther information is requested
    help wantedExtra attention is needed
    on Sep 13, 2019
  2. alerque commented on Sep 18, 2019

    @alerque
    OwnerAuthor

    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.

  3. alerque commented on Sep 23, 2019

    @alerque
    OwnerAuthor

    Note the Python implementation has API docs on readthedocs.

  4. alerque commented on Mar 10, 2022

    @alerque
    OwnerAuthor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationhelp wantedExtra attention is neededquestionFurther information is requested

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions