-
Notifications
You must be signed in to change notification settings - Fork 155
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
Ad/documentation #272
Ad/documentation #272
Conversation
Reviewing it! |
Hey! I'm closing the PR temporarily. I realise that a how-to might not be relevant as "documentation" for the library. I'll try and add some docstrings to the essential parts of the library so that a proper documentation can be made with tools like Sphinx. Let me know if you have any feedback! |
Hi @anishhdiwan, it looks good overall. And everything is done in separate in separate doc. |
Hello @Denys88, that sounds great! I can reopen the PR then. Could you please add the README link (not sure where it'd fit the best)? I will also add the docstrings soon and send another PR at a later time. Thanks |
Will do it. |
Yep, its Anish Diwan. I just added it to the doc. Thanks |
* Add docs * Update docs; Rename file * Add author --------- Co-authored-by: anishdiwan <anishdiwan@diwan-ubuntu20.04>
Added an explanation of some core classes from rl_games and how they work. Also added a guide on using rl_games for your own work (using a style similar to IsaacGymEnvs).
@Denys88 I hope this is accurate and helps others easily adapt rl_games to their own work :)