Review and refinement of API docs

[dotsdl]

Working on making the API docs more polished.
Closes #32.

[dotsdl]

I think I've gone about as far as I'd like to go on this. There are surely objects and methods that could use better documentation, but this is better done gradually as we notice gaps than trying to do it in one PR.

[codecov-commenter]

Codecov Report

Patch coverage has no change and project coverage change: +0.03% 🎉

Comparison is base (b7c90ee) 81.98% compared to head (50a63a8) 82.01%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #177      +/-   ##
==========================================
+ Coverage   81.98%   82.01%   +0.03%     
==========================================
  Files          21       21              
  Lines        2681     2680       -1     
==========================================
  Hits         2198     2198              
+ Misses        483      482       -1     

Files Changed	Coverage Δ
alchemiscale/base/api.py	86.48% <ø> (ø)
alchemiscale/base/client.py	78.08% <ø> (ø)
alchemiscale/cli.py	78.08% <ø> (ø)
alchemiscale/compute/api.py	63.91% <ø> (ø)
alchemiscale/compute/client.py	100.00% <ø> (ø)
alchemiscale/compute/service.py	81.28% <ø> (ø)
alchemiscale/interface/api.py	41.36% <ø> (ø)
alchemiscale/interface/client.py	90.80% <ø> (ø)
alchemiscale/models.py	97.16% <ø> (ø)
alchemiscale/security/auth.py	89.18% <ø> (ø)
... and 6 more

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

[hmacdope]

Looks good to me @dotsdl. One thing I might add is mentioning the permissive MIT licensing in developer docs, or even on home page of the docs (only if you like).

[dotsdl]

Thanks @hmacdope! Added this to the top-level index for the docs!