Skip to content

[Documentation] Start Documentation and docstrings #8

Description

@TioMinho

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.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions