Skip to content

Added documentation for environments. #22

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

Merged
merged 3 commits into from
Feb 14, 2023

Conversation

ppasupat
Copy link
Collaborator

@ppasupat ppasupat commented Feb 13, 2023

Description

  • Created a class for each environment and wrote documentation in docstrings.
  • Generated Markdowns by adapting gen_md.py from Gymnasium.

This PR depends on PR #21.

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

Checklist:

  • I have run the pre-commit checks with pre-commit run --all-files (see CONTRIBUTING.md instructions to set it up)
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

Copy link
Member

@pseudo-rnd-thoughts pseudo-rnd-thoughts left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good

To keep the documentation update, normally, the documentation is generated on each PR.
@mgoulao Can we add this feature like we have in Gymnasium?

@mgoulao
Copy link
Contributor

mgoulao commented Feb 13, 2023

@ppasupat add a workflow like this https://github.com/Farama-Foundation/Gymnasium/blob/main/.github/workflows/build-docs.yml, you need to change some parts, like "Install Gymnasium" or "Install dependencies" .
Generated files should be ignored by git, so I would suggest you remove all Markdown files that are generated using gen_md.py and add a line to the .gitignore with something like docs/environments/miniwob/*.md.

@ppasupat
Copy link
Collaborator Author

I added build-docs.yml and the files it mentions. I also added .gitignore.

@pseudo-rnd-thoughts pseudo-rnd-thoughts merged commit a8d4dcc into Farama-Foundation:master Feb 14, 2023
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

Successfully merging this pull request may close these issues.

3 participants