Add api docs

[hannahbaumann]

No description provided.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 96.10%. Comparing base (5260e3b) to head (d098ec5).
⚠️ Report is 12 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #74      +/-   ##
==========================================
+ Coverage   88.16%   96.10%   +7.94%     
==========================================
  Files           7        6       -1     
  Lines         338      334       -4     
==========================================
+ Hits          298      321      +23     
+ Misses         40       13      -27     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

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

[hannahbaumann]

pre-commit.ci autofix

[IAlibay]

Very quick drive-by review.

[IAlibay]

I'll let @jthorton do the proper review here.

[atravitz]

@hannahbaumann I see you used openfe's docs as a baseline here, but openfe has a lot of extra bells and whistles that openfe-analysis doesn't need. Could I suggest that you use gufe's docs as a starting point instead? It inherits directly from furo and will work better out-of-the-box.

[atravitz]

added some suggestions for cleaning up unneeded code - let me know if there are any items you want to discuss.

[hannahbaumann]

pre-commit.ci autofix

[atravitz]

@hannahbaumann I added docs build to the CI, and it's failing with a few formatting errors. Once those are addressed this is good to go!