[Feature request] Add generated documentation to the library
arxaqapi opened this issue · comments
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.
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.
I would be up to help with the documentation process.
Let me take a look at the different options for documentation generation.
Awesome! Thank you so much.
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.