Skip to main content

API docs

· One min read
Pantelis Sopasakis
Lecturer, QUB

The API docs of gradgen are now available here. The API docs have been generated automatically from the docstrings in the code using Sphinx.

For example, you can find detailed API docs for the SingleShootingBundle class, SquaredDistanceToSet and a lot more.

The API docs are still under development. Currently, the majority of public API endpoints (classes, methods, functions) have API docs. The next step will be to include examples and code snippets everywhere.

Note that best way to get started with gradgen is our online documentation, not the API docs.