Add new api-documentation

[Sparks29032]

No description provided.

[Sparks29032]

Generated w/ api-docs from scikit-package

[github-actions]

Warning! No news item is found for this PR. If this is a user-facing
change/feature/fix,
please add a news item by copying the format from news/TEMPLATE.rst.
For best practices, please visit
https://scikit-package.github.io/scikit-package/frequently-asked-questions.html#billinge-group-standards.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.07%. Comparing base (ec78bf2) to head (e11bfba).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #228   +/-   ##
=======================================
  Coverage   99.07%   99.07%           
=======================================
  Files          21       21           
  Lines        1079     1079           
=======================================
  Hits         1069     1069           
  Misses         10       10           

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.