search

NeLy-EPFL / flygym

Simulating embodied sensorimotor control with NeuroMechFly v2
https://neuromechfly.org/
Apache License 2.0
20 stars 6 forks source link

Refactor documentation #172

Closed sibocw closed 3 months ago

sibocw commented 3 months ago

Description

I have refactored the autodocs in the API References section of the Sphinx site according to the v1.x.x API. When you get the time, could you please take a look if I missed anything? @tkclam This is not urgent; we can merge this when we merge the new tutorials.

I have also removed from core import NeuroMechFly, Parameters from the root-level __init__.py. Do we plan to just remove support for the old API (core.py)?

Types of changes

Does this address any currently open issues?

...

tkclam commented 3 months ago

Documentation looks good to me. Currently there's a deprecation warning in the __init__ of NeuroMechFly. I was planning to remove it in the next major release, but we can also do it now.

sibocw commented 3 months ago

Perfect, thank you. I removed from the shorthand imports from __init__.py though, do you think this is OK?

PS. You convinced me to finally install a spell checker in VS Code... thank you for fixing these!

tkclam commented 3 months ago

Yes, I think that's fine