Skip to content

Add ilamb3 API documentation #181

Description

@nocollier

While not pertinent to the current effort, we will soon want entire API documentation for the ilamb3 project. I have loosely followed numpydoc rules throughout but I am sure that an automated tool will find that many of the docstrings are lacking.

  • Which tool do we integrate with myst to do the generation?
  • Create a page that will link to the index page.
  • Cleanup docstrings.

I also think this is a good moment to add flags/notes to functions we aren't sure we need or that might be good to revamp/revisit.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    Status
    Backlog

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions