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

Update documentation #105

Merged
merged 3 commits into from Jul 3, 2023
Merged

Conversation

enerrio
Copy link
Contributor

@enerrio enerrio commented Jul 3, 2023

Description

This PR updates the documentation to include installation instructions in the Basic Usage page and includes instructions for how to build the documentation in the README.md file within the docs folder (in a fashion similar to Petting Zoo's docs)

Type of change

  • 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 run pytest -v and no errors are present.
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I solved any possible warnings that pytest -v has generated that are related to my code to the best of my knowledge.
  • 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

@rodrigodelazcano
Copy link
Member

Thanks! For the installation docs can you also specify the Python versions and OS we support. Like in PettingZoo docs

@enerrio
Copy link
Contributor Author

enerrio commented Jul 3, 2023

@rodrigodelazcano sure! Just to confirm, are the python versions and OS listed in Petting Zoo the same for Minari? i.e. Python 3.7 - 3.10 on Linux and MacOS.

@rodrigodelazcano
Copy link
Member

@rodrigodelazcano sure! Just to confirm, are the python versions and OS listed in Petting Zoo the same for Minari? i.e. Python 3.7 - 3.10 on Linux and MacOS.

Correct, and Python 3.11 as well

@rodrigodelazcano rodrigodelazcano merged commit 6b0cc8c into Farama-Foundation:main Jul 3, 2023
12 checks passed
@enerrio enerrio deleted the update_docs branch July 3, 2023 20:49
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.

None yet

2 participants