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

[Documentation] Start Documentation and docstrings #8

Open
3 tasks
TioMinho opened this issue Apr 23, 2023 · 0 comments
Open
3 tasks

[Documentation] Start Documentation and docstrings #8

TioMinho opened this issue Apr 23, 2023 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@TioMinho
Copy link
Member

TioMinho commented Apr 23, 2023

Summary

The package is progressing but the documentation is still empty. I'm creating this issue as a both a reminder and tracker for starting the documentation page and to not implement more function without docstrings.

Tasks

  • Define the docs/ layout and start populating the pages with some content. Suggestion is for the tabs: Introduction (including Quickstart), Examples, Manual, Contribution Guide, API Reference, Release notes.
  • Define a docstrings style and start documenting all functions.
  • Upload simple benchmark systems that can be downloaded and used directly through the package (gym style). We can then restrict the tutorials/examples to those systems.
@TioMinho TioMinho added the documentation Improvements or additions to documentation label Apr 23, 2023
@TioMinho TioMinho self-assigned this Apr 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant