RobertTLange / evosax

Evolution Strategies in JAX 🦎
Apache License 2.0
475 stars 44 forks source link

[Feature request] Add generated documentation to the library #53

Open arxaqapi opened 1 year ago

arxaqapi commented 1 year ago

Having an automatically generated documentation website for evosax would be very helpful. Currently, the API needs to be checked by looking at the source code or code examples every time one is unsure about something.

RobertTLange commented 1 year ago

Thank you for raising this @arxaqapi -- I fully agree. But simply haven't found the time to get this done. Would you be up for helping out with this? I guess this shouldn't take super long together with copilot. Also do you have recommendations how to host this? sphinx doesn't seem very visually pleasing.

arxaqapi commented 1 year ago

I would be up to help with the documentation process.

Let me take a look at the different options for documentation generation.

RobertTLange commented 1 year ago

Awesome! Thank you so much.

arxaqapi commented 1 year ago

Some update on the documentation.

I found pdoc, which is a nice little library to automatically generate API documentation. After some tweaking, an initial draft of what the documentation could look like is live here: https://arxaqapi.github.io/evosax.

Here is where I am working on the documentation.