desy-ml / cheetah

Fast and differentiable particle accelerator optics simulation for reinforcement learning and optimisation applications.
https://cheetah-accelerator.readthedocs.io
GNU General Public License v3.0
28 stars 13 forks source link

Add Sphinx autodoc #53

Closed jank324 closed 1 year ago

jank324 commented 1 year ago

A further pull request addressing #2. Adds the Sphinx autodoc extension that automatically generates parts of the documentation for all the classes and functions from their docstrings.