LLNL / SSAPy

A Python package allowing for fast and precise orbital modeling.
https://software.llnl.gov/SSAPy/
MIT License
36 stars 8 forks source link

Add basic documentation + small fixes #4

Closed igoumiri closed 4 months ago

igoumiri commented 5 months ago

Add some basic documentation for the API reference. Also clean up some of the imports so that the imported classes don't appear as duplicates in the API reference. I wonder if there is a cleaner way to do that than importing Thing as _Thing like I did.

Add a README in docs/ to explain how to build the docs.

Also fix some leftover x2y -> x_to_y references to util functions, mostly in tests.