Skip to content

Autogenerated API documentation #269

@galenseilis

Description

@galenseilis
  • Ciw's online documentation is already quite good, but it doesn't have the same autogenerated API documentation that I think users have come to expect from many other packages.
  • Getting Sphinx to generate API docs will require plugins, such as naploleon.
  • Will need to expand on the Numpy-compliant docstrings in the codebase.
  • Should add type annotations in most places as well.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions