Autogenerated API documentation #269

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Open

galenseilis opened this issue Apr 9, 2025 · 0 comments

Contributor

galenseilis commented Apr 9, 2025

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.

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