Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
arxaqapi opened this issue May 3, 2023 · 4 comments
Open

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

arxaqapi opened this issue May 3, 2023 · 4 comments

Comments

@arxaqapi
Copy link

arxaqapi commented May 3, 2023

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
Copy link
Owner

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
Copy link
Author

I would be up to help with the documentation process.

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

@RobertTLange
Copy link
Owner

Awesome! Thank you so much.

@arxaqapi
Copy link
Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants